Skip to main content

PublicKey

@hyperledger/identus-sdk v7.0.0


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

Abstract Class: PublicKey

Defined in: src/domain/models/keyManagement/PublicKey.ts:3

Extends

Constructors

Constructor

new PublicKey(): PublicKey

Returns

PublicKey

Inherited from

Key.constructor

Properties

PropertyModifierTypeInherited fromDefined in
keySpecificationabstractMap<string, string>Key.keySpecificationsrc/domain/models/keyManagement/Key.ts:13
rawabstractUint8ArrayKey.rawsrc/domain/models/keyManagement/Key.ts:15
sizeabstractnumberKey.sizesrc/domain/models/keyManagement/Key.ts:14
toabstract{ Buffer: () => Buffer; String: (encoding?: BufferEncoding) => string; }Key.tosrc/domain/models/keyManagement/Key.ts:16
to.Bufferpublic() => Buffer-src/domain/models/keyManagement/exportable/ExportableKey.ts:31
to.Stringpublic(encoding?: BufferEncoding) => string-src/domain/models/keyManagement/exportable/ExportableKey.ts:32
typeabstractKeyTypesKey.typesrc/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

Inherited from

Key.alg


curve

Get Signature

get curve(): string

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

Returns

string

Inherited from

Key.curve


value

Get Signature

get value(): Uint8Array<ArrayBufferLike>

Defined in: src/domain/models/keyManagement/PublicKey.ts:4

Returns

Uint8Array<ArrayBufferLike>

Methods

canVerify()

canVerify(): this is VerifiableKey

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

Returns

this is VerifiableKey

Inherited from

Key.canVerify


getEncoded()

abstract getEncoded(): Uint8Array

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

Returns

Uint8Array

Inherited from

Key.getEncoded


getProperty()

getProperty(name: string): string | undefined

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

Parameters

ParameterType
namestring

Returns

string | undefined

Inherited from

Key.getProperty


isCurve()

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

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

Type Parameters

Type Parameter
T

Parameters

ParameterType
curvestring

Returns

this is T

Inherited from

Key.isCurve


isDerivable()

isDerivable(): this is DerivableKey

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

Returns

this is DerivableKey

Inherited from

Key.isDerivable


isExportable()

isExportable(): this is All

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

Returns

this is All

Inherited from

Key.isExportable


isSignable()

isSignable(): this is SignableKey

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

Returns

this is SignableKey

Inherited from

Key.isSignable


isStorable()

isStorable(): this is StorableKey

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

Returns

this is StorableKey

Inherited from

Key.isStorable