Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

JS: Helpers

Helpers

@yuneta/gobj-js ships the helpers that a gclass needs, and it gives them the names that the C side uses. A gclass that moves between the two languages keeps its calls.

Source code: src/helpers.js, src/sprintf.js

FamilyPage
The JSON operations of jansson, and the type predicatesJSON and type helpers
Reading and writing a kw, the kwid records, and the inter-event metadatakw, kwid and inter-event helpers
The comparisons of strings, the lists, the time and the general utilitiesString, list and general helpers
Building elements, escaping untrusted values, and the languageDOM and i18n helpers
The database in memory, the files, the HTTP and the tokensLocal database, transport and token helpers
The writers of logs and traces, and the formattingLogging

Every symbol of the package is in the JS API index.


Two rules that a caller trips on

A path uses the back-tick, and not the point. kw_get_str(gobj, kw, "__md_iev__`__msg_type__", "", 0) goes down two levels. A path with a point in it is one key that holds a point in its name.

Most helpers take gobj first, and a few do not. kw_has_key(), kw_pop(), kw_match_simple(), msg_iev_read_key() and msg_iev_write_key() take none. The gobj names the gobj in a log message, and it changes nothing else.