Expand description
An item’s change token on a GitHub board: what Task::version,
Project::version and
Document::version hold here, and the one
ordering of two of them.
docs/plugin-protocol.md §4.13d is the specification: the parts the token is built from, the
change kinds each covers member by member, and why a token waits for its item to settle. What
is here is how this module holds to it. Each part is selected by every list, search and
detail read already, so the token costs no request; an item missing any part — a draft, an
item this process wrote and has not read back, or one whose labels or board field values
came back as only a first page — gives none. order says how two tokens of one issue
stand to each other, and an item whose later time is within SETTLED of the response’s
Date, or read from a response without one, gives no token.
Structs§
- Facets
- What an item is and holds that neither of its times moves for: its own kind, the value of every board field it holds one of, and every label it carries, each named by what a person can rename — a field option’s name, a label’s name and colour.
- Facets
Digest - The lowercase hex SHA-256 of an item’s
Facets: the token’s facets part, held to that spelling so a token spelled from it is always oneordercan read back. - Parts
- What one token of this plugin is made of.
Enums§
- Facet
Kind - The kind of item a token’s facets name: the one closed set the canonical JSON’s
kindholds.
Constants§
- PREFIX
- What every token this plugin gives starts with, so a reader can tell it from another plugin’s.
- SETTLED
- How long before the response that read it an item must last have changed for its token to be given.
Functions§
- order
- How the version
aof one issue stands to its versionb:Greaterwhenais the later,Lesswhen it is the earlier,Equalonly when every part is equal — andNonewhen either is not a token of this plugin, or the two cannot be put in order. - settled
- Whether an issue last changed at
issue, whose board item last changed atitem, had settled byserved— theDateof the response that read it — so its token may be given. - spell
- The token these parts spell.