assertIsMessageModifyingSigner

function assertIsMessageModifyingSigner<TAddress, TValue>(
    value,
): asserts value is Readonly<{
    address: Address<TAddress>;
    modifyAndSignMessages: any;
}> &
    TValue;

Asserts that the provided value implements the MessageModifyingSigner interface.

Type Parameters

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

Parameters

ParameterType
valueTValue

Returns

asserts value is Readonly<{ address: Address<TAddress>; modifyAndSignMessages: any }> & TValue

Example

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

See

isMessageModifyingSigner

On this page