Class RelativeDistinguishedNames

Represents the RelativeDistinguishedNames structure described in RFC5280

Hierarchy

PkiObject
- RelativeDistinguishedNames

Implements

IRelativeDistinguishedNames

Index

Constructors

Properties

typesAndValues valueBeforeDecode CLASS_NAME

Accessors

Methods

fromSchema isEqual toJSON toSchema toString blockName compareWithDefault defaultValues fromBER schema

Constructors

constructor

new RelativeDistinguishedNames(parameters?: RelativeDistinguishedNamesParameters): RelativeDistinguishedNames
Initializes a new instance of the RelativeDistinguishedNames class
Parameters
- parameters: RelativeDistinguishedNamesParameters = {}
  
  Initialization parameters
Returns RelativeDistinguishedNames
Overrides PkiObject.constructor
- Defined in src/RelativeDistinguishedNames.ts:50

Properties

typesAndValues

typesAndValues: AttributeTypeAndValue[]

Array of "type and value" objects

valueBeforeDecode

valueBeforeDecode: ArrayBuffer

Value of the RDN before decoding from schema

`Static` CLASS_NAME

CLASS_NAME: string = "RelativeDistinguishedNames"

Name of the class

Accessors

className

get className(): string
Returns string
Inherited from PkiObject.className
- Defined in src/PkiObject.ts:65

Methods

fromSchema

fromSchema(schema: any): void
Converts parsed ASN.1 object into current class
Parameters
- schema: any
  
  ASN.1 schema
Returns void
Overrides PkiObject.fromSchema
- Defined in src/RelativeDistinguishedNames.ts:126

isEqual

isEqual(compareTo: unknown): boolean
Compares two RDN values, or RDN with ArrayBuffer value
Parameters
- compareTo: unknown
  
  The value compare to current
Returns boolean
- Defined in src/RelativeDistinguishedNames.ts:182

toJSON

toJSON(): RelativeDistinguishedNamesJson
Converts the class to JSON object

Returns
JSON object

Returns RelativeDistinguishedNamesJson
Overrides PkiObject.toJSON
- Defined in src/RelativeDistinguishedNames.ts:172

toSchema

toSchema(): Sequence
Converts current object to ASN.1 object and sets correct values

Returns
ASN.1 object

Returns Sequence
Overrides PkiObject.toSchema
- Defined in src/RelativeDistinguishedNames.ts:153

toString

toString(encoding?: "base64" | "base64url" | "hex"): string
Parameters
- encoding: "base64" | "base64url" | "hex" = "hex"
Returns string
Inherited from PkiObject.toString
- Defined in src/PkiObject.ts:88

`Static` blockName

blockName(): string
Returns block name

Returns
Returns string block name

Returns string
Inherited from PkiObject.blockName
- Defined in src/PkiObject.ts:27

`Static` compareWithDefault

compareWithDefault(memberName: string, memberValue: any): boolean
Compares values with default values for all class members
Parameters
- memberName: string
  
  String name for a class member
- memberValue: any
  
  Value to compare with default value
Returns boolean
- Defined in src/RelativeDistinguishedNames.ts:84

`Static` defaultValues

defaultValues(memberName: "typesAndValues"): AttributeTypeAndValue[]
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "typesAndValues"
  
  String name for a class member
Returns AttributeTypeAndValue[]
Overrides PkiObject.defaultValues
- Defined in src/RelativeDistinguishedNames.ts:66
defaultValues(memberName: "valueBeforeDecode"): ArrayBuffer
Parameters
- memberName: "valueBeforeDecode"
Returns ArrayBuffer
Overrides PkiObject.defaultValues
- Defined in src/RelativeDistinguishedNames.ts:67

`Static` fromBER

fromBER<T>(this: PkiObjectConstructor<T>, raw: BufferSource): T
Creates PKI object from the raw data

Returns
Initialized and filled current class object
Type Parameters
- T extends PkiObject<T>
Parameters
- this: PkiObjectConstructor<T>
- raw: BufferSource
  
  ASN.1 encoded raw data
Returns T
Inherited from PkiObject.fromBER
- Defined in src/PkiObject.ts:36

`Static` schema

schema(parameters?: RelativeDistinguishedNamesSchema): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: RelativeDistinguishedNamesSchema = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/RelativeDistinguishedNames.ts:105

Generated using TypeDoc