Class SigDict

A dictionary's names by id. Ids are positions, so SigDict.at is what strings[id] used to be.

Implements

Iterable<string>

Index

Accessors

Methods

keyOf of ofLines [iterator] at groupOf

Accessors

length

get length(): number
how many names it holds

Returns number
- Defined in src/project/sigdb/dict.ts:62

Methods

`Static`keyOf

keyOf(name: string): number
The group name would be in, so a lookup only compares the names that could match it.
Parameters
- name: string
Returns number
- Defined in src/project/sigdb/dict.ts:78

`Static`of

of(names: readonly string[]): SigDict
The dictionary names spells out.
Parameters
- names: readonly string[]
Returns SigDict
- Defined in src/project/sigdb/dict.ts:22

`Static`ofLines

ofLines(lines: Buffer): SigDict
The dictionary a bundle's d lines spell out, each ["d", start, "name\nname..."] (or the legacy ["d", start, [names]]). The names are unescaped from the line's bytes straight into the dictionary, as parsing every line into a string only to encode it back took most of the time opening a database costs. The runs must cover the ids from 0 without a gap.
Parameters
- lines: Buffer
Returns SigDict
- Defined in src/project/sigdb/dict.ts:41

[iterator]

"[iterator]"(): Iterator<string>
Returns Iterator<string>
Implementation of Iterable.[iterator]
- Defined in src/project/sigdb/dict.ts:87

at

at(id: number): string
The name with the given id, '' for an id the dictionary does not hold.
Parameters
- id: number
Returns string
- Defined in src/project/sigdb/dict.ts:67

groupOf

groupOf(id: number): number
The group the name with the given id belongs to, as SigDict.keyOf groups one in hand.
Parameters
- id: number
Returns number
- Defined in src/project/sigdb/dict.ts:72