Class FtDeclaredParameters

Container for declared parameters in .ftx file headers. Manages version and meta reference parameters.

Index

Constructors

Accessors

Methods

add clear getAllRecsExceptVersion getMetaReference getName getValue indexOfName indexOfVersion remove setMetaReference setVersion tryGetVersion tryGetVersionRec

Constructors

constructor

new FtDeclaredParameters(): FtDeclaredParameters
Returns FtDeclaredParameters

Accessors

count

get count(): number
Returns number
- Defined in lib/src/serialization/ft-declared-parameters.ts:29

Methods

add

add(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void
- Defined in lib/src/serialization/ft-declared-parameters.ts:41

clear

clear(): void
Returns void
- Defined in lib/src/serialization/ft-declared-parameters.ts:64

getAllRecsExceptVersion

getAllRecsExceptVersion(): FtDeclaredParameterRec[]
Returns FtDeclaredParameterRec[]
- Defined in lib/src/serialization/ft-declared-parameters.ts:156

getMetaReference

getMetaReference(): { reference: string; type: FtMetaReferenceType }
Returns { reference: string; type: FtMetaReferenceType }
- Defined in lib/src/serialization/ft-declared-parameters.ts:94

getName

getName(idx: number): string
Parameters
- idx: number
Returns string
- Defined in lib/src/serialization/ft-declared-parameters.ts:33

getValue

getValue(idx: number): string
Parameters
- idx: number
Returns string
- Defined in lib/src/serialization/ft-declared-parameters.ts:37

indexOfName

indexOfName(name: string): number
Parameters
- name: string
Returns number
- Defined in lib/src/serialization/ft-declared-parameters.ts:68

indexOfVersion

indexOfVersion(): number
Returns number
- Defined in lib/src/serialization/ft-declared-parameters.ts:77

remove

remove(name: string): void
Parameters
- name: string
Returns void
- Defined in lib/src/serialization/ft-declared-parameters.ts:57

setMetaReference

setMetaReference(type: FtMetaReferenceType, reference: string): void
Parameters
- type: FtMetaReferenceType
- reference: string
Returns void
- Defined in lib/src/serialization/ft-declared-parameters.ts:122

setVersion

setVersion(major: number, minor: number, comment?: string): void
Parameters
- major: number
- minor: number
- comment: string = ''
Returns void
- Defined in lib/src/serialization/ft-declared-parameters.ts:81

tryGetVersion

tryGetVersion(): Result<Version, boolean>
Returns Result<Version, boolean>
- Defined in lib/src/serialization/ft-declared-parameters.ts:85

tryGetVersionRec

tryGetVersionRec(): { rec: FtDeclaredParameterRec; success: boolean }
Returns { rec: FtDeclaredParameterRec; success: boolean }
- Defined in lib/src/serialization/ft-declared-parameters.ts:144