erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-28 19:27:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 17

docs(common/models/templates): a bit more for traversal child method

Browse source
This commit is contained in:
Joshua A. Horton 2024-03-14 21:47:51 +07:00
parent 64efabbc49
commit 6de595394b
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
common/models/types/index.d.ts vendored
View file

@ -59,6 +59,10 @@ declare interface LexiconTraversal {
* If such a traversal state is not supported, returns `undefined`.
* Implementations may choose to return `undefined` if more than one UTF-16
* codepoint is appended, even if such a descendant exists.
*
* Note: traversals navigate and represent the lexicon in its "keyed" state,
* as produced by use of the search-term keying function defined for the model.
* That is, if a model "keys" `è` to `e`, there will be no `è` child.
* @param char
*/
child(char: USVString): LexiconTraversal | undefined;