Function assertIsKeyPairSigner

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

  • Asserts that the provided value implements the KeyPairSigner interface.

    Type Parameters

    • TAddress extends string

      The inferred type of the address provided.

    Parameters

    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.

Settings

Member Visibility