Separate classes for groups of methods (#1)

* added resourcetype interface that's imported and reused

* added membergroupmembership; comments formatting typedoc output; updated types

* separate classes for groups of methods

* additional methods added, suggested changes made, typedoc documentation improved
This commit is contained in:
Nick Trochalakis
2025-01-11 14:57:09 -08:00
committed by GitHub
parent 27b6abc928
commit 7254e6e5b3
110 changed files with 2199 additions and 1326 deletions
+23
View File
@@ -0,0 +1,23 @@
---
title: Contributing
group: Contributing
---
# Contributing
## Updating Documentation
Documentation is setup to be hosted on github pages, it is generated using typedoc.
Typedoc documentation can be found here: <https://typedoc.org/>
### Guides
The files for the guides are located in the documentation folder, they are written in markdown
### Module Documentation
To update the typedoc generated documentation for the module, run the following commands in the root of the repo:
npm install # Install only needs to be run first time.
npm run docs
+6
View File
@@ -0,0 +1,6 @@
---
title: Examples
group: Examples
---
# Examples
+33
View File
@@ -0,0 +1,33 @@
---
title: Installing
group: Installing
---
# Installing
This library is not in NPM. As a result, you need to add it to your project and build it locally.
## Adding library source to project
To do so, you have three options:
- Add the repository to the consuming repository as a Git submodule.
- Clone the repository locally.
- Copy the files locally, without maintaining a Git repository.
Regardless of which option you choose, the following steps all apply.
## Building the library
Enter the lib directory for the library and run the following commands:
npm install
npm run build
## Installing the Library to Project
In your project directory, run the following:
npm i /path/to/package/d4h-typescript/lib
Using a relative path will also work without issue.
+6
View File
@@ -0,0 +1,6 @@
---
title: Using the Library
group: Using
---
# Using the Library