Skip to main content

sign

function sign
Jump to headingsign(
algorithm:
string
| null
| undefined
,
data: ArrayBufferView,
): Buffer

Calculates and returns the signature for data using the given private key and algorithm. If algorithm is null or undefined, then the algorithm is dependent upon the key type (especially Ed25519 and Ed448).

If key is not a KeyObject, this function behaves as if key had been passed to createPrivateKey. If it is an object, the following additional properties can be passed:

If the callback function is provided this function uses libuv's threadpool.

Parameters Jump to heading

Return Type Jump to heading

Buffer
Jump to headingsign(
algorithm:
string
| null
| undefined
,
data: ArrayBufferView,
callback: (
error: Error | null,
data: Buffer,
) => void
,
): void

Parameters Jump to heading

Jump to headingalgorithm:
string
| null
| undefined
Jump to headingdata: ArrayBufferView
Jump to headingcallback: (
error: Error | null,
data: Buffer,
) => void

Return Type Jump to heading

void
Back to top