SchemaKey Class
The SchemaKey contains a Schemas name and version.
Methods
Name | Description | |
---|---|---|
constructor(name: string, version: ECVersion): SchemaKey | ||
constructor(name: string, readVersion?: number, writeVersion?: number, minorVersion?: number): SchemaKey | ||
compareByName(rhs: string | SchemaKey): boolean | Compares two schema names, case-insensitive. | |
compareByVersion(rhs: SchemaKey): number | Compares two schema versions. | |
matches(rhs: Readonly<SchemaKey>, matchType: SchemaMatchTypeSchemaMatchType.Exact): boolean | ||
toJSON(): SchemaKeyProps | Save this SchemaKey's properties to an object for serializing to JSON. | |
toString(padZeroes: booleantrue): string | Creates a string, in the format 'RR.ww.mm', representing this SchemaKey. | |
fromJSON(props: SchemaKeyProps): SchemaKey Static | Deserializes a SchemaKeyProps JSON object into a SchemaKey object. | |
parseString(fullName: string): SchemaKey Static |
Properties
Name | Type | Description | |
---|---|---|---|
_version Protected | ECVersion | ||
minorVersion Accessor ReadOnly | number | ||
name Accessor ReadOnly | string | ||
readVersion Accessor ReadOnly | number | ||
version Accessor ReadOnly | ECVersion | ||
writeVersion Accessor ReadOnly | number |
Defined in
Last Updated: 14 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.