assertIsMessagePartialSigner

function assertIsMessagePartialSigner<TAddress>(
    value,
): asserts value is Readonly<{
    address: Address<TAddress>;
    signMessages: any;
}>;

Asserts that the provided value implements the MessagePartialSigner 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 Readonly<{ address: Address<TAddress>; signMessages: any }>

Example

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

See

isMessagePartialSigner

On this page