Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
28 lines
1.1 KiB
Plaintext
28 lines
1.1 KiB
Plaintext
import type { JWK, CompactJWSHeaderParameters, KeyLike, SignOptions } from '../../types';
|
|
/**
|
|
* The CompactSign class is used to build and sign Compact JWS strings.
|
|
*
|
|
* This class is exported (as a named export) from the main `'jose'` module entry point as well as
|
|
* from its subpath export `'jose/jws/compact/sign'`.
|
|
*
|
|
*/
|
|
export declare class CompactSign {
|
|
private _flattened;
|
|
/** @param payload Binary representation of the payload to sign. */
|
|
constructor(payload: Uint8Array);
|
|
/**
|
|
* Sets the JWS Protected Header on the Sign object.
|
|
*
|
|
* @param protectedHeader JWS Protected Header.
|
|
*/
|
|
setProtectedHeader(protectedHeader: CompactJWSHeaderParameters): this;
|
|
/**
|
|
* Signs and resolves the value of the Compact JWS string.
|
|
*
|
|
* @param key Private Key or Secret to sign the JWS with. See
|
|
* {@link https://github.com/panva/jose/issues/210#jws-alg Algorithm Key Requirements}.
|
|
* @param options JWS Sign options.
|
|
*/
|
|
sign(key: KeyLike | Uint8Array | JWK, options?: SignOptions): Promise<string>;
|
|
}
|