Directory structure

All files that are a part of this library are split into multiple directories. Here you can find a short summary of all the directories and which files belong in which directory.

Directory structure

• ./build/
  The build directory contains all files that are generated by the build process. They are not included in the repository and should not be manually edited. They are deployed to the npm registry.
• ./docs/
  The docs directory contains all documentation files. It is split into two subdirectories:
  • ./docs/api/
    The API documentation directory contains the automatically generated API documentation. More information about the API documentation can be found in the API documentation section of the wiki. These files are not included in the repository and should not be manually edited. They are generated by the documentation generation process.
  • ./docs/wiki/
    The wiki directory contains a git submodule with the wiki documentation.
• ./src/
  The source directory contains all the source files in TypeScript. Detailed information about the code structure can be found in the Code structure section of the wiki.
• ./tests/ The tests directory contains all the tests. More information about testing can be found in the Testing section of the wiki.

Root

The root directory contains the following files:

• ./.gitattributes
  The .gitattributes file contains a list of files that should be treated differently by the Git version control system. It is used by the Git version control system.
• ./.gitignore
  The .gitignore file contains a list of files that should not be included in the repository. It is used by the Git version control system.
• ./.prettierrc
  The .prettierrc file contains configuration for the Prettier code formatter. It is used by the Prettier code formatter.
• CODE_OF_CONDUCT.md
  The CODE_OF_CONDUCT.md file contains the code of conduct for the library. It is used by the GitHub repository.
• CONTRIBUTING.md
  The CONTRIBUTING.md file contains information about how to contribute to the library. It is used by the GitHub repository.
• LICENSE
  The LICENSE file contains the license of the library.
• README.md
  The README.md file contains the readme of the library. It is used by the GitHub repository, the npm package, and the API documentation.
• SECURITY.md
  The SECURITY.md file contains information about security and how to report possible security vunerabilities. It is used by the GitHub repository.
• jest.config.js
  The jest.config.js file contains configuration for the Jest testing framework. It is used by the Jest testing framework.
• package-lock.json
  The package-lock.json file contains information about the exact versions of all dependencies. It is used by the npm package manager (or any other package manager).
• package.json
  The package.json file contains information about the library. It is used by the npm package manager (or any other package manager). It also contains scripts that can be run using the npm package manager (or any other package manager).
• tsconfig.json
  The tsconfig.json file contains configuration for the TypeScript compiler. It is used by the TypeScript compiler.
• typedoc.json
  The typedoc.json file contains configuration for the TypeDoc documentation generator. It is used by the TypeDoc documentation generator.