Class VmSignPublicKey

A public signature key.

Hierarchy (View Summary)

VmSignType
- VmSignPublicKey

Index

Constructors

Accessors

Methods

alg encode isPublic isSecret isSignature material toJSON toPublic toSecret toSignature toString typ fromParts parse

Constructors

constructor

new VmSignPublicKey(data: Uint8Array): VmSignPublicKey
Parameters
- data: Uint8Array
Returns VmSignPublicKey
Overrides VmSignType.constructor
- Defined in types.ts:259

Accessors

[toStringTag]

get "[toStringTag]"(): string
Try to show the string repr when debugging.

Returns string
Inherited from VmSignType.[toStringTag]
- Defined in types.ts:162

Methods

alg

alg(): string
Get the algorithm.

Returns string
Inherited from VmSignType.alg
- Defined in types.ts:173

encode

encode(): Uint8Array
Get the full encoded version of this type.

Returns Uint8Array
Inherited from VmSignType.encode
- Defined in types.ts:141

isPublic

isPublic(): boolean
Is this a public key?

Returns boolean
Inherited from VmSignType.isPublic
- Defined in types.ts:194

isSecret

isSecret(): boolean
Is this a secret key?

Returns boolean
Inherited from VmSignType.isSecret
- Defined in types.ts:215

isSignature

isSignature(): boolean
Is this a signature?

Returns boolean
Inherited from VmSignType.isSignature
- Defined in types.ts:236

material

material(): Uint8Array
Get the material portion of this type.

Returns Uint8Array
Inherited from VmSignType.material
- Defined in types.ts:187

toJSON

toJSON(): string
Also use the string repr for JSON.

Returns string
Inherited from VmSignType.toJSON
- Defined in types.ts:155

toPublic

toPublic(): VmSignPublicKey
Convert this to a public key.

Returns VmSignPublicKey
Inherited from VmSignType.toPublic
- Defined in types.ts:205

toSecret

toSecret(): VmSignSecretKey
Convert this to a public key.

Returns VmSignSecretKey
Inherited from VmSignType.toSecret
- Defined in types.ts:226

toSignature

toSignature(): VmSignature
Convert this to a public key.

Returns VmSignature
Inherited from VmSignType.toSignature
- Defined in types.ts:247

toString

toString(): string
Stringify this type into the base64url repr.

Returns string
Inherited from VmSignType.toString
- Defined in types.ts:148

typ

typ(): Uint8Array
Get the typ.

Returns Uint8Array
Inherited from VmSignType.typ
- Defined in types.ts:180

`Static`fromParts

fromParts(alg: string, material: Uint8Array): VmSignPublicKey
Construct a public key from components.
Parameters
- alg: string
- material: Uint8Array
Returns VmSignPublicKey
Overrides VmSignType.fromParts
- Defined in types.ts:272

`Static`parse

parse(encoded: string): VmSignType
Parameters
- encoded: string
Returns VmSignType
Overrides VmSignType.parse
- Defined in types.ts:265