Class SchemasSpec

A specification mapping schema prefixes to SchemaSpec objects.

Index

Constructors

Accessors

Methods

[iterator] addSchemaSpec parseVersionSpecs

Constructors

constructor

new SchemasSpec(): SchemasSpec
Constructor.

Returns SchemasSpec
- Defined in src/schema/specs.js:184

Accessors

data

get data(): Map<string, SchemaSpec[]>
The specification mapping data.

Returns Map<string, SchemaSpec[]>
A copy of the map from prefixes to the specifications listed under them.
- Defined in src/schema/specs.js:193

Methods

[iterator]

"[iterator]"(): Generator<[string, SchemaSpec[]], void, unknown>
Iterate over the schema specifications.

Returns Generator<[string, SchemaSpec[]], void, unknown>

Yields
Each prefix and its specifications.
- Defined in src/schema/specs.js:202

addSchemaSpec

addSchemaSpec(schemaSpec: SchemaSpec): SchemasSpec
Add a schema to this specification.

The specification is appended to its prefix's list; a schema listed twice in one group is reported when the group is built (schemaGroupInvalid).
Parameters
- schemaSpec: SchemaSpec
  A schema specification.
Returns SchemasSpec
This object.
- Defined in src/schema/specs.js:215

`Static`parseVersionSpecs

parseVersionSpecs(versionSpecs: string | string[]): SchemasSpec
Parse a HED version specification into a schemas specification object.
Parameters
- versionSpecs: string | string[]
  The HED version specification, can be a single version string or array of version strings.
Returns SchemasSpec
A schemas specification object containing parsed schema specifications.

Throws
If any schema specification is invalid.
- Defined in src/schema/specs.js:232