TPVector is written entirely in TypeScript. At any time, the most modern features of the language might be used.
All the classes and most interfaces in TPVector are immutable. For more details, see the Immutability doc.
The constructors are always protected (or private), and classes are instantiated
using static constructor methods, like create(...), fromBlob(...) etc.
The code is formatted using the vscode.typescript-language-features formatter,
with the formatting options stored
.vscode/settings.json. The formatter gives a lot of
freedom, some choices were made for consistency:
- Single quotes are used for imports, backticks are used for user-visible messages, other string literals use double quotes, or backticks as template literals.
The code is well structured and self-documenting as much as possible. JSDoc is added where it is needed, or clearly beneficial, and the HTML documentation is generated using typedoc, configured in typedoc.json. However, it might be a good idea to read the code of the library, and not just the docs.
The generated documentation is available here: Documentation.
When writing JSDoc, there are no strict requirements on using the tags like
@param etc. A free-form text explaining the entity is enough.