Key

@hyperledger/identus-sdk v7.0.0

---

@hyperledger/identus-sdk / overview / Domain / Key

Abstract Class: Key

Defined in: src/domain/models/keyManagement/Key.ts:11

Extended by

• PrivateKey
• PublicKey

Constructors

Constructor

new Key(): Key

Returns

Key

Properties

Property	Modifier	Type	Defined in
keySpecification	abstract	Map<string, string>	src/domain/models/keyManagement/Key.ts:13
raw	abstract	Uint8Array	src/domain/models/keyManagement/Key.ts:15
size	abstract	number	src/domain/models/keyManagement/Key.ts:14
to	abstract	{ Buffer: () => Buffer; String: (encoding?: BufferEncoding) => string; }	src/domain/models/keyManagement/Key.ts:16
to.Buffer	public	() => Buffer	src/domain/models/keyManagement/exportable/ExportableKey.ts:31
to.String	public	(encoding?: BufferEncoding) => string	src/domain/models/keyManagement/exportable/ExportableKey.ts:32
type	abstract	KeyTypes	src/domain/models/keyManagement/Key.ts:12

Accessors

alg

Get Signature

get alg(): JWT_ALG

Defined in: src/domain/models/keyManagement/Key.ts:25

Returns

JWT_ALG

---

curve

Get Signature

get curve(): string

Defined in: src/domain/models/keyManagement/Key.ts:20

Returns

string

Methods

canVerify()

canVerify(): this is VerifiableKey

Defined in: src/domain/models/keyManagement/Key.ts:53

Returns

this is VerifiableKey

---

getEncoded()

abstract getEncoded(): Uint8Array

Defined in: src/domain/models/keyManagement/Key.ts:18

Returns

Uint8Array

---

getProperty()

getProperty(name: string): string | undefined

Defined in: src/domain/models/keyManagement/Key.ts:57

Parameters

Parameter	Type
name	string

Returns

string | undefined

---

isCurve()

isCurve<T>(curve: string): this is T

Defined in: src/domain/models/keyManagement/Key.ts:61

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
curve	string

Returns

this is T

---

isDerivable()

isDerivable(): this is DerivableKey

Defined in: src/domain/models/keyManagement/Key.ts:37

Returns

this is DerivableKey

---

isExportable()

isExportable(): this is All

Defined in: src/domain/models/keyManagement/Key.ts:41

Returns

this is All

---

isSignable()

isSignable(): this is SignableKey

Defined in: src/domain/models/keyManagement/Key.ts:45

Returns

this is SignableKey

---

isStorable()

isStorable(): this is StorableKey

Defined in: src/domain/models/keyManagement/Key.ts:49

Returns

this is StorableKey