Mono-repository for thi.ng TypeScript/ES6 projects, a collection of largely data / transformation oriented packages and building blocks reactive applications, components (not just UI related), dataflow.
All/most packages:
- have detailed, individual README files w/ small usage examples
- versioned independently
- distributed as ES6 (CommonJS modules) with bundled TypeScript typings & changelogs
- highly modular with largely only a few closely related functions / single class per file to help w/ tree shaking
- provide re-exports of all their publics for full library imports
- have either none or only @thi.ng internal runtime dependencies (see graph below)
- declare public interfaces, enums & types in an
src/api.ts
file (larger packages only) - autogenerated online documentation at docs.thi.ng
- licensed under Apache Software License 2.0
There's a steadily growing number of standalone examples (different difficulties, many combining functionality from several packages) in the examples directory.
(This graph is updated automatically after each version update)
git clone https://github.com/thi-ng/umbrella.git
cd umbrella
yarn build
# build all examples (from project root)
yarn examples
# in example dir
yarn dev
(TODO not all packages have tests yet)
yarn test
# or individually
lerna run test --scope @thi.ng/rstream
The resulting reports will be saved under /packages/*/coverage/lcov-report/
.
yarn cover
Autogenerated documentation (using
TypeDoc) will be saved under
/packages/*/doc/
and is also available at docs.thi.ng.
yarn doc