Abstract Class: Key
@hyperledger/identus-sdk v8.1.3
@hyperledger/identus-sdk / overview / Domain / Key
Abstract Class: Key
Defined in: packages/shared/domain/build/index.d.ts:798
Extended by
Constructors
Constructor
new Key():
Key
Returns
Key
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
keySpecification | abstract | Map<string, string> | packages/shared/domain/build/index.d.ts:800 |
raw | abstract | Uint8Array | packages/shared/domain/build/index.d.ts:802 |
size | abstract | number | packages/shared/domain/build/index.d.ts:801 |
to | abstract | { Buffer: () => Buffer; String: (encoding?: BufferEncoding) => string; } | packages/shared/domain/build/index.d.ts:803 |
to.Buffer | public | () => Buffer | packages/shared/domain/build/index.d.ts:725 |
to.String | public | (encoding?: BufferEncoding) => string | packages/shared/domain/build/index.d.ts:726 |
type | abstract | KeyTypes | packages/shared/domain/build/index.d.ts:799 |
Accessors
alg
Get Signature
get alg():
JWT_ALG
Defined in: packages/shared/domain/build/index.d.ts:807
Returns
curve
Get Signature
get curve():
string
Defined in: packages/shared/domain/build/index.d.ts:805
Returns
string
data
Get Signature
get data():
Uint8Array
Defined in: packages/shared/domain/build/index.d.ts:806
Returns
Uint8Array
Methods
canVerify()
canVerify():
this is VerifiableKey
Defined in: packages/shared/domain/build/index.d.ts:812
Returns
this is VerifiableKey
getEncoded()
abstractgetEncoded():Uint8Array
Defined in: packages/shared/domain/build/index.d.ts:804
Returns
Uint8Array
getProperty()
getProperty(
name:string):string|undefined
Defined in: packages/shared/domain/build/index.d.ts:813
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
string | undefined
isCurve()
isCurve<
T>(curve:string):this is T
Defined in: packages/shared/domain/build/index.d.ts:814
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
curve | string |
Returns
this is T
isDerivable()
isDerivable():
this is DerivableKey
Defined in: packages/shared/domain/build/index.d.ts:808
Returns
this is DerivableKey
isExportable()
isExportable():
this is All
Defined in: packages/shared/domain/build/index.d.ts:809
Returns
this is All
isSignable()
isSignable():
this is SignableKey
Defined in: packages/shared/domain/build/index.d.ts:810
Returns
this is SignableKey
isStorable()
isStorable():
this is StorableKey
Defined in: packages/shared/domain/build/index.d.ts:811
Returns
this is StorableKey