assertIsKeyPairSigner

assertIsKeyPairSigner<TAddress>(value): asserts value is KeyPairSigner<TAddress>

Asserts that the provided value implements the KeyPairSigner interface.

Type Parameters

Type Parameter	Description
`TAddress` extends `string`	The inferred type of the address provided.

Parameters

Parameter	Type
`value`	{[`key`: `string`]: `unknown`; `address`: `Address`<`TAddress`>; }
`value.address`	`Address`<`TAddress`>

Returns

asserts value is KeyPairSigner<TAddress>

Example

import { generateKeyPairSigner, assertIsKeyPairSigner } from '@solana/signers';
 
const signer = await generateKeyPairSigner();
assertIsKeyPairSigner(signer); // void
assertIsKeyPairSigner({ address: address('1234..5678') }); // Throws an error.

assertIsKeyPairSigner

Type Parameters

Parameters

Returns

Example

On this page