Kit
Functions

assertIsMessageSigner

assertIsMessageSigner<TAddress>(value): asserts value is MessageSigner<TAddress>

Asserts that the provided value implements the MessageSigner interface.

Type Parameters

Type ParameterDescription
TAddress extends stringThe inferred type of the address provided.

Parameters

ParameterType
value{[key: string]: unknown; address: Address<TAddress>; }
value.addressAddress<TAddress>

Returns

asserts value is MessageSigner<TAddress>

Example

import { Address } from '@solana/addresses';
import { assertIsMessageSigner } from '@solana/signers';
 
const address = '1234..5678' as Address<'1234..5678'>;
assertIsMessageSigner({ address, signMessages: async () => {} }); // void
assertIsMessageSigner({ address, modifyAndSignMessages: async () => {} }); // void
assertIsMessageSigner({ address }); // Throws an error.

See

isMessageSigner

assertIsMessagePartialSigner

Previous Page

assertIsOffCurveAddress

Next Page

On this page