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 web/src/serialization/ft-declared-parameters.ts:30

Methods

add

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

clear

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

getAllRecsExceptVersion

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

getMetaReference

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

getName

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

getValue

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

indexOfName

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

indexOfVersion

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

remove

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

setMetaReference

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

setVersion

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

tryGetVersion

tryGetVersion(): FtResult<Version, boolean>
Returns FtResult<Version, boolean>
- Defined in web/src/serialization/ft-declared-parameters.ts:86

tryGetVersionRec

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