isMessageSigner

function isMessageSigner<TAddress>(
    value,
): value is MessageSigner<TAddress>;

Checks whether 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

value is MessageSigner<TAddress>

Example

import { Address } from '@solana/addresses';
import { isMessageSigner } from '@solana/signers';
 
const address = '1234..5678' as Address<'1234..5678'>;
isMessageSigner({ address, signMessages: async () => {} }); // true
isMessageSigner({ address, modifyAndSignMessages: async () => {} }); // true
isMessageSigner({ address }); // false

See

assertIsMessageSigner

On this page