assertIsMessageSigner

function assertIsMessageSigner<TAddress, TValue>(
    value,
): asserts value is MessageSigner<TAddress> & TValue;

Asserts that the provided value implements the MessageSigner interface.

Type Parameters

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

Parameters

ParameterType
valueTValue

Returns

asserts value is MessageSigner<TAddress> & TValue

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

On this page