isMessagePartialSigner

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

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

value is Readonly<{ address: Address<TAddress>; signMessages: any }>

Example

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

See

assertIsMessagePartialSigner

On this page