API Reference › ecschema-Locaters › Locaters › FileSchemaKey

FileSchemaKey Class

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: undefined | string | SchemaKey): boolean SchemaKey Compares two schema names, case-insensitive.
compareByVersion(rhs: SchemaKey): number SchemaKey Compares two schema versions.
matches(rhs: Readonly<SchemaKey>, matchType?: SchemaMatchType): boolean SchemaKey  
toJSON(): SchemaKeyProps SchemaKey Save this SchemaKey's properties to an object for serializing to JSON.
toString(padZeroes?: boolean): string SchemaKey Creates a string, in the format 'RR.ww.mm', representing this SchemaKey.
fromJSON(props: SchemaKeyProps): SchemaKey Static SchemaKey Deserializes a SchemaKeyProps JSON object into a SchemaKey object.
parseString(fullName: string): SchemaKey Static SchemaKey  

Properties

Name Type Description
fileName string    
schemaText undefined | string    

Inherited properties

Name Type Inherited from Description
_version Protected ECVersion SchemaKey  
minorVersion Accessor ReadOnly number SchemaKey  
name Accessor ReadOnly string SchemaKey  
readVersion Accessor ReadOnly number SchemaKey  
version Accessor ReadOnly ECVersion SchemaKey  
writeVersion Accessor ReadOnly number SchemaKey  

Defined in

Last Updated: 16 April, 2024