FileSchemaKey Class @beta
A SchemaKey implementation that aids in identifying Schema files via the addition of two properties: fileName and schemaText. The fileName contains the full path to the file on disk and schemaText is the full string representation of the Schema.
Extends
Methods
| Name | Description | |
|---|---|---|
| constructor(key: SchemaKey, fileName: string, schemaJson?: string): FileSchemaKey | Initializes a new FileSchemaKey object. |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| compareByName(rhs: string | SchemaKey): boolean Inherited | SchemaKey | Compares two schema names, case-insensitive. |
| compareByVersion(rhs: SchemaKey): number Inherited | SchemaKey | Compares two schema versions. |
| matches(rhs: Readonly<SchemaKey>, matchType?: SchemaMatchType): boolean Inherited | SchemaKey | |
| toJSON(): SchemaKeyProps Inherited | SchemaKey | Save this SchemaKey's properties to an object for serializing to JSON. |
| toString(padZeroes?: boolean): string Inherited | SchemaKey | Creates a string, in the format 'RR.ww.mm', representing this SchemaKey. |
| fromJSON(props: SchemaKeyProps): SchemaKey Static Inherited | SchemaKey | Deserializes a SchemaKeyProps JSON object into a SchemaKey object. |
| parseString(fullName: string): SchemaKey Static Inherited | SchemaKey |
Properties
| Name | Type | Description | |
|---|---|---|---|
| fileName | string | ||
| schemaText | string | undefined |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| _version Protected Inherited | ECVersion | SchemaKey | |
| minorVersion Accessor Inherited ReadOnly | number | SchemaKey | |
| name Accessor Inherited ReadOnly | string | SchemaKey | |
| readVersion Accessor Inherited ReadOnly | number | SchemaKey | |
| version Accessor Inherited ReadOnly | ECVersion | SchemaKey | |
| writeVersion Accessor Inherited ReadOnly | number | SchemaKey |
Defined in
Last Updated: 24 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.