Class HNamespace

Haystack namespace.

A namespace holds a collection of normalized defs.

Constructors

constructor

new HNamespace(grid: HGrid): HNamespace
Constructs a new namespace.
Parameters
- grid: HGrid
Returns HNamespace
- Defined in src/core/HNamespace.ts:167

Accessors

choices

get choices(): NameToDefs
Returns NameToDefs
An object containing names to subtypes for all defs that are choices.
- Defined in src/core/HNamespace.ts:601

conjuncts

get conjuncts(): readonly HDict[]
Returns readonly HDict[]
A list of all available conjunct defs.
- Defined in src/core/HNamespace.ts:301

defs

get defs(): Defs
Returns a defs lookup map.

Since defs are keyed by a symbol this map provides fast look up.

Returns Defs
A object with key to value defs.
- Defined in src/core/HNamespace.ts:198

featureNames

get featureNames(): string[]
Returns string[]
The name of the available features.
- Defined in src/core/HNamespace.ts:625

features

get features(): readonly HDict[]
Returns readonly HDict[]
A list of feature defs.
- Defined in src/core/HNamespace.ts:403

grid

get grid(): HGrid
Returns HGrid
The underlying grid for the namespace.
- Defined in src/core/HNamespace.ts:1237

hsTypeDefs

get hsTypeDefs(): {
    bool: HDict;
    coord: HDict;
    date: HDict;
    dateTime: HDict;
    dict: HDict;
    grid: HDict;
    list: HDict;
    marker: HDict;
    na: HDict;
    number: HDict;
    ref: HDict;
    str: HDict;
    symbol: HDict;
    time: HDict;
    uri: HDict;
    xstr: HDict;
}
Returns {
    bool: HDict;
    coord: HDict;
    date: HDict;
    dateTime: HDict;
    dict: HDict;
    grid: HDict;
    list: HDict;
    marker: HDict;
    na: HDict;
    number: HDict;
    ref: HDict;
    str: HDict;
    symbol: HDict;
    time: HDict;
    uri: HDict;
    xstr: HDict;
}
The defs for all of the core haystack value types.
- Defined in src/core/HNamespace.ts:1081

libs

get libs(): HDict[]
Returns HDict[]
A list of all the libs implemented by this namespace.
- Defined in src/core/HNamespace.ts:450

tagOnIndices

get tagOnIndices(): NameToDefs
Returns NameToDefs
A object that maps def names to their respective tagOn defs.
- Defined in src/core/HNamespace.ts:671

tagOnNames

get tagOnNames(): string[]
Returns string[]
A list of all the tagOn names.
- Defined in src/core/HNamespace.ts:649

timezones

get timezones(): HList<HStr>
Returns HList<HStr>
A list of available timezones.
- Defined in src/core/HNamespace.ts:1254

`Static`defaultNamespace

get defaultNamespace(): HNamespace
Returns HNamespace
The default namespace for the environment.
- Defined in src/core/HNamespace.ts:174
set defaultNamespace(namespace: HNamespace): void
Set the default namespace for the environment.
Parameters
- namespace: HNamespace
  The new default namespace.
Returns void
- Defined in src/core/HNamespace.ts:186

Methods

allSubTypesOf

allSubTypesOf(name: string | HSymbol): HDict[]
Returns a flattened list of all the subtypes.
Parameters
- name: string | HSymbol
  The def name.
Returns HDict[]
A list of subtypes.
- Defined in src/core/HNamespace.ts:480

allSuperTypesOf

allSuperTypesOf(name: string | HSymbol): HDict[]
Returns a flattened list of all the supertypes in the whole supertype chain.
Parameters
- name: string | HSymbol
  The def name.
Returns HDict[]
A list of supertypes.
- Defined in src/core/HNamespace.ts:561

associations

associations(parent: string | HSymbol, association: string | HSymbol): HDict[]
Return an array of defs for the given association on the parent.
Parameters
- parent: string | HSymbol
  The parent def.
- association: string | HSymbol
  The association.
Returns HDict[]
An array of associated defs.
- Defined in src/core/HNamespace.ts:718

byAllNames

byAllNames(...names: (string | string[] | HSymbol | HSymbol[])[]): HDict[]
Return an array of dicts via their names. If a name can't be found then throw an error.
Parameters
- ...names: (string | string[] | HSymbol | HSymbol[])[]
  The names of the defs to look up.
Returns HDict[]
A array of defs.

Throws
An error if the def can't be found.
- Defined in src/core/HNamespace.ts:266

byName

byName(name: string | HSymbol): undefined | HDict
Return a def via its name or undefined if it can't be found.
Parameters
- name: string | HSymbol
  The name of the def to look up.
Returns undefined | HDict
The def or undefined if it can't be found.
- Defined in src/core/HNamespace.ts:220

choicesFor

choicesFor(name: string | HSymbol): HDict[]
Returns the choices for def.
Parameters
- name: string | HSymbol
  The def name.
Returns HDict[]
The choices for a def.
- Defined in src/core/HNamespace.ts:591

conjunctDefs

conjunctDefs(name: string | HSymbol): HDict[]
Decomposes a conjunct into its respective defs and returns them.

If the def is not a conjunct then it will just return itself.
Parameters
- name: string | HSymbol
  The conjunct def to breakdown.
Returns HDict[]
The defs the conjunct references.

Throws
An error if any of the defs are invalid.
- Defined in src/core/HNamespace.ts:337

defOfDict

defOfDict(subject: HDict): HDict
Match the most specific marker entity type for the specified dict.
Parameters
- subject: HDict
  The subject dict.
Returns HDict
The entity def or dict if one cannot be found.
- Defined in src/core/HNamespace.ts:870

defToKind

defToKind(name: string | HSymbol): undefined | Kind
Return the Haystack kind value from the def. If the def is invalid or a kind cannot be ascertained then return undefined.

Please note, curVal and writeVal are scalars but don't extend a def that could relate to a concrete type (i.e. number or bool). This implies these values can be any scalar and hence match multiple kinds. In this case undefined will be returned for the kind.
Parameters
- name: string | HSymbol
  The name of the def to get the kind for.
Returns undefined | Kind
The kind or undefined it one cannot be found.
- Defined in src/core/HNamespace.ts:1025

findContainmentRef

findContainmentRef(name: string | HSymbol): undefined | HDict
Return the first containment ref def that matches the specified name.

Please note, this will filter out any defs that are marked as deprecated.
Parameters
- name: string | HSymbol
  The name of the def to search the ref for.
Returns undefined | HDict
The containment ref def.
- Defined in src/core/HNamespace.ts:1606

fits

fits(name: string | HSymbol, base: string | HSymbol): boolean
Return true if the specified def fits the base def.

If true this means that def is assignable to types of base. This is effectively the same as checking if inheritance(def) contains base.
Parameters
- name: string | HSymbol
  The def name.
- base: string | HSymbol
  The name of the base def.
Returns boolean
True if the def fits.
- Defined in src/core/HNamespace.ts:928

fitsChoice

fitsChoice(name: string | HSymbol): boolean
Return true if the specified def is a choice.
Parameters
- name: string | HSymbol
  The def name.
Returns boolean
True if the def is a choice.
- Defined in src/core/HNamespace.ts:959

fitsEntity

fitsEntity(name: string | HSymbol): boolean
Return true if the specified def is a entity.
Parameters
- name: string | HSymbol
  The def name.
Returns boolean
True if the def is a entity.
- Defined in src/core/HNamespace.ts:969

fitsMarker

fitsMarker(name: string | HSymbol): boolean
Return true if the specified def is a marker.
Parameters
- name: string | HSymbol
  The def name.
Returns boolean
True if the def is a marker.
- Defined in src/core/HNamespace.ts:939

fitsVal

fitsVal(name: string | HSymbol): boolean
Return true if the specified def is a val.
Parameters
- name: string | HSymbol
  The def name.
Returns boolean
True if the def is a val.
- Defined in src/core/HNamespace.ts:949

get

get(name: string | HSymbol): undefined | HDict
Return a def via its name or undefined if it can't be found.

This method is a duplicate of byName.
Parameters
- name: string | HSymbol
  The name of the def to look up.
Returns undefined | HDict
The def or undefined if it can't be found.
- Defined in src/core/HNamespace.ts:232

getContainmentRefs

getContainmentRefs(): HDict[]
Return all the containment refs available.

Returns HDict[]
A list of all the containment refs.
- Defined in src/core/HNamespace.ts:1594

has

has(name: string | HSymbol): boolean
Return true if the def exists in the namespace.

This method is a duplicate of hasName.
Parameters
- name: string | HSymbol
  The name of the def to look up.
Returns boolean
True if the def exists.
- Defined in src/core/HNamespace.ts:254

hasName

hasName(name: string | HSymbol): boolean
Return true if the def exists in the namespace.
Parameters
- name: string | HSymbol
  The name of the def to look up.
Returns boolean
True if the def exists.
- Defined in src/core/HNamespace.ts:242

hasRelationship

hasRelationship(
    __namedParameters: {
        queried?: Set<string>;
        ref?: HRef;
        relName: string | HSymbol;
        relTerm?: string | HSymbol;
        resolve?: (ref: HRef) => undefined | HDict;
        subject: HDict;
    },
): boolean
Query a subject's relationship.

Relationships model how entities are related to one another via instance to instance relationships versus def to def associations.

https://project-haystack.dev/doc/docHaystack/Relationships#querying
Parameters
- __namedParameters: {
      queried?: Set<string>;
      ref?: HRef;
      relName: string | HSymbol;
      relTerm?: string | HSymbol;
      resolve?: (ref: HRef) => undefined | HDict;
      subject: HDict;
  }
Returns boolean
True if a match is made.
- Defined in src/core/HNamespace.ts:1280

hasSubTypes

hasSubTypes(name: string | HSymbol): boolean
Returns true if the def has subtypes.
Parameters
- name: string | HSymbol
  The def name.
Returns boolean
True if the def has subtypes.
- Defined in src/core/HNamespace.ts:470

implementation

implementation(name: string | HSymbol): HDict[]
Return the tags that should be added for implementation.
Parameters
- name: string | HSymbol
  The def name.
Returns HDict[]
An array of defs to be added.
- Defined in src/core/HNamespace.ts:979

inheritance

inheritance(name: string | HSymbol): HDict[]
Return the defs inheritance as a flattened array of defs.
Parameters
- name: string | HSymbol
  The def name.
Returns HDict[]
The def's inheritance.
- Defined in src/core/HNamespace.ts:694

is

is(parent: string | HSymbol): HDict[]
Return an array of defs for the is association on the parent.
Parameters
- parent: string | HSymbol
  The parent def.
Returns HDict[]
An array of associated defs.
- Defined in src/core/HNamespace.ts:817

isValid

isValid(name: string | HSymbol, dict: unknown): boolean
Return true if the dict is valid for the specified tag.
Parameters
- name: string | HSymbol
  The tag name.
- dict: unknown
  The dict to validate against.
Returns boolean
true if the dict is valid.
- Defined in src/core/HNamespace.ts:1552

newDict

newDict(names: (string | HSymbol)[]): HDict
Create a new dict with all the default required tags.
Parameters
- names: (string | HSymbol)[]
  The names of the tags to add.
Returns HDict
The new dict with all the default requirement tags.
- Defined in src/core/HNamespace.ts:1567

protos

protos(parent: HDict): HDict[]
Return a reflected array of children prototypes for the parent dict.
Parameters
- parent: HDict
Returns HDict[]
An array of children.
- Defined in src/core/HNamespace.ts:1125

reflect

reflect(subject: HDict): Reflection
Analyze the subject dict and return its implemented defs.
Parameters
- subject: HDict
  The subject dict.
Returns Reflection
The reflected defs.
- Defined in src/core/HNamespace.ts:847

subTypesOf

subTypesOf(name: string | HSymbol): HDict[]
Returns the subtypes of the type.
Parameters
- name: string | HSymbol
  The def name.
Returns HDict[]
The subtypes.
- Defined in src/core/HNamespace.ts:460

superTypesOf

superTypesOf(name: string | HSymbol): HDict[]
Returns the supertypes of a def or an empty array if it can't be found.
Parameters
- name: string | HSymbol
  The def name.
Returns HDict[]
The supertype defs.
- Defined in src/core/HNamespace.ts:542

tagOn

tagOn(parent: string | HSymbol): HDict[]
Return an array of defs for the tagOn association on the parent.
Parameters
- parent: string | HSymbol
  The parent def.
Returns HDict[]
An array of associated defs.
- Defined in src/core/HNamespace.ts:827

toGrid

toGrid(): HGrid
Return a grid for the namespace.

Returns HGrid
A grid with all the definitions.
- Defined in src/core/HNamespace.ts:1246

validate

validate(name: string | HSymbol, dict: unknown): void
Validates a dict for a tag.
```
try {
  namespace.validate('site', new HDict({ site: HMarker.make() }))
}
catch(err) {
  console.error(err)
}
```
Parameters
- name: string | HSymbol
  The name of the tag to validate.
- dict: unknown
  The dict to validate against.
Returns void
Throws
An error if the tags on the dict are not valid.
- Defined in src/core/HNamespace.ts:1420

validateAll

validateAll(dict: unknown): void
Validates all of the tags on the dict. Any tags that don't exist in the namespcae will be skipped.
```
try {
  namespace.validateAll(new HDict({ site: HMarker.make() }))
}
catch(err) {
  console.error(err)
}
```
Parameters
- dict: unknown
  The dict to validate.
Returns void
Throws
An error if the tags on the dict are not valid.
- Defined in src/core/HNamespace.ts:1528

`Static`getFeature

getFeature(name: string | HSymbol): string
Return the feature from the feature key. An empty string is returned if no feature can be found.

For example, lib:foo would return lib.
Parameters
- name: string | HSymbol
  The name to parse.
Returns string
The feature.
- Defined in src/core/HNamespace.ts:429

`Static`getFeatureName

getFeatureName(name: string | HSymbol): string
Return the feature name from the feature key. An empty string is returned if no feature name can be found.

For example, lib:foo would return foo.
Parameters
- name: string | HSymbol
  The name to parse.
Returns string
The feature name.
- Defined in src/core/HNamespace.ts:442

`Static`isConjunct

isConjunct(name: string | HSymbol): boolean
Return true if the name is for a conjunct.
Parameters
- name: string | HSymbol
  The name to test.
Returns boolean
True if the name is for a conjunct.
- Defined in src/core/HNamespace.ts:314

`Static`isFeature

isFeature(name: string | HSymbol): boolean
Return true if the name is for a feature.
Parameters
- name: string | HSymbol
  The name to test.
Returns boolean
True if the name is for a feature.
- Defined in src/core/HNamespace.ts:416

`Static`splitConjunct

splitConjunct(name: string | HSymbol): string[]
Split the conjunct name into its component parts.
Parameters
- name: string | HSymbol
  The name to split.
Returns string[]
The split marker tag names for the conjunct.
- Defined in src/core/HNamespace.ts:324

Class HNamespace

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns HNamespace

Accessors

choices

Returns NameToDefs

conjuncts

Returns readonly HDict[]

defs

Returns Defs

featureNames

Returns string[]

features

Returns readonly HDict[]

grid

Returns HGrid

hsTypeDefs

Returns { bool: HDict; coord: HDict; date: HDict; dateTime: HDict; dict: HDict; grid: HDict; list: HDict; marker: HDict; na: HDict; number: HDict; ref: HDict; str: HDict; symbol: HDict; time: HDict; uri: HDict; xstr: HDict;}

libs

Returns HDict[]

tagOnIndices

Returns NameToDefs

tagOnNames

Returns string[]

timezones

Returns HList<HStr>

StaticdefaultNamespace

Returns HNamespace

Parameters

Returns void

Methods

allSubTypesOf

Parameters

Returns HDict[]

allSuperTypesOf

Parameters

Returns HDict[]

associations

Parameters

Returns HDict[]

byAllNames

Parameters

Returns HDict[]

Throws

byName

Parameters

Returns undefined | HDict

choicesFor

Parameters

Returns HDict[]

conjunctDefs

Parameters

Returns HDict[]

Throws

defOfDict

Parameters

Returns HDict

defToKind

Parameters

Returns undefined | Kind

findContainmentRef

Parameters

Returns undefined | HDict

fits

Parameters

Returns boolean

fitsChoice

Parameters

Returns boolean

fitsEntity

Parameters

Returns boolean

fitsMarker

Parameters

Returns {
bool: HDict;
coord: HDict;
date: HDict;
dateTime: HDict;
dict: HDict;
grid: HDict;
list: HDict;
marker: HDict;
na: HDict;
number: HDict;
ref: HDict;
str: HDict;
symbol: HDict;
time: HDict;
uri: HDict;
xstr: HDict;
}

`Static`defaultNamespace

`Static`getFeature

`Static`getFeatureName