assertIsTransactionModifyingSigner

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

Asserts that the provided value implements the TransactionModifyingSigner 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>; modifyAndSignTransactions: any }>

Example

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

See

isTransactionModifyingSigner

On this page