Crypto React
    Preparing search index...

    Interface UseSignatureResult

    Return type of the useSignature hook.

    const { sign, verify, signature, isValid }: UseSignatureResult = useSignature();
    interface UseSignatureResult {
        sign: (
            privateKey: string,
            message: string | Uint8Array<ArrayBufferLike>,
            algorithm?: SignAlgorithm,
        ) => string;
        verify: (
            publicKey: string,
            message: string | Uint8Array<ArrayBufferLike>,
            signature: string,
            algorithm?: SignAlgorithm,
        ) => boolean;
        signature: string | null;
        isValid: boolean | null;
        isProcessing: boolean;
    }
    Index
    sign verify signature isValid isProcessing
    sign: (
        privateKey: string,
        message: string | Uint8Array<ArrayBufferLike>,
        algorithm?: SignAlgorithm,
    ) => string

    Sign a message. Returns the hex-encoded signature.

    verify: (
        publicKey: string,
        message: string | Uint8Array<ArrayBufferLike>,
        signature: string,
        algorithm?: SignAlgorithm,
    ) => boolean

    Verify a signature. Returns true if valid.

    signature: string | null

    The last produced hex-encoded signature.

    isValid: boolean | null

    The result of the last verify() call.

    isProcessing: boolean

    True while a sign or verify operation is in progress.

    Settings
    Member Visibility

    On This Page
    Properties