zadam/trilium
1
1
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-09 13:21:33 +08:00
Code Issues Projects Releases Packages Wiki Activity

docs(note_create): improve clarification of type system

Browse source
This commit is contained in:
Jakob Schlanstedt 2025-10-22 15:47:31 +02:00 • committed by Jakob Schlanstedt
parent b82d75674a
commit ee532eea45
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
apps/client/src/services/note_create.ts
View file

@ -14,7 +14,7 @@ import dateNoteService from "../services/date_notes.js";
/** /**
* Creating notes through note_create can have multiple kinds of valid * Creating notes through note_create can have multiple kinds of valid
* arguments. This type hierchary is checking if the arguments are correct. * arguments. This type hierarchy is checking if the arguments are correct.
* Later the functions of note_create are overloaded based to reflect these types, * Later the functions of note_create are overloaded based to reflect these types,
* which define valid arguments. * which define valid arguments.
* *
@ -22,9 +22,10 @@ import dateNoteService from "../services/date_notes.js";
* create a valid state, given that the types are defined correctly. * create a valid state, given that the types are defined correctly.
* Through the Curry–Howard correspondence, this acts as a proof system * Through the Curry–Howard correspondence, this acts as a proof system
* proving that the arguments will produce a correct state at compile time. * proving that the arguments will produce a correct state at compile time.
* that just means that if the code type-checks, then the provided options * That means when typescript does type-checks, then the arguments will
* represent a valid state. To represent the theoretical bases `type` is * definitely represent a valid state.
* used instead of `interface` *
* To represent the theoretical bases `type` is used instead of `interface`
* *
* * Hierarchy of general to specific categories(hypernyms -> hyponyms): * * Hierarchy of general to specific categories(hypernyms -> hyponyms):
* *