Skip to main content

getCipherInfo

function getCipherInfo
Jump to headinggetCipherInfo(
nameOrNid: string | number,
): CipherInfo | undefined

Returns information about a given cipher.

Some ciphers accept variable length keys and initialization vectors. By default, the crypto.getCipherInfo() method will return the default values for these ciphers. To test if a given key length or iv length is acceptable for given cipher, use the keyLength and ivLength options. If the given values are unacceptable, undefined will be returned.

Parameters Jump to heading

Jump to headingnameOrNid: string | number

The name or nid of the cipher to query.

Return Type Jump to heading

CipherInfo | undefined
Back to top