isMessageModifyingSigner

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

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

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

Example

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

See

assertIsMessageModifyingSigner

On this page