You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/**
* Encodes a did:key from bytes
*
* @example
* eencodeDIDfromBytes('p256-pub',new Uint8Array([...])) , or see index.test.ts for constructing Uint8Arrays from strings
*
* @param {CodecName} multicodecName see https://github.com/multiformats/multicodec/blob/master/table.csv for a list of names
* @param {Uint8Array} publicKey public key expressed as byte Array
* @return {string} a did:key, see spec https://w3c-ccg.github.io/did-method-key/ for form
*/
/**
* Creates a configured signer function for signing data using the ES256K (secp256k1 + sha256) algorithm.
*
* The signing function itself takes the data as a `Uint8Array` or `string` and returns a `base64Url`-encoded signature
*
* @example
* ```typescript
* const sign: Signer = ES256KSigner(process.env.PRIVATE_KEY)
* const signature: string = await sign(data)
* ```
*
* @param {String} privateKey a private key as `Uint8Array`
* @param {Boolean} recoverable an optional flag to add the recovery param to the generated signatures
* @return {Function} a configured signer function `(data: string | Uint8Array): Promise<string>`
*/
The text was updated successfully, but these errors were encountered:
The hover behavior should look like what is provided by a library like did-jwt:
Instead I am getting something like this where the function description is shown, but the JSDoc comments do not appear:
For more information see: https://code.visualstudio.com/docs/languages/typescript#_jsdoc-support and https://jsdoc.app/
For an example of JSDoc comments that currently do not work see:
https://github.com/bshambaugh/did-key-creator/blob/main/src/encodeDIDkey.ts#L6-L15
For an example of JSDoc comments that currently do work see:
https://github.com/decentralized-identity/did-jwt/blob/master/src/signers/ES256KSigner.ts#L9-L23
The text was updated successfully, but these errors were encountered: