Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.57 KB

README.md

File metadata and controls

59 lines (39 loc) · 2.57 KB

Cobalt

Need info? Read on! | or Create an issue | or Ask us on Discord


Cobalt is a utilities library for Typescript. You can use it with any TypeScript project including backend, frontend and mobile apps.

Note that this project uses functional programming constructs so it is advised to read up on the relevant projects if you're not familiar with them.

Packages

This is a list of published packages that you can add to your project. Follow the links if you'd like to learn more about how they work.

  • Authorization: Authorization utilities
  • Core: Core utilities shared by all packages
  • Events: In-memory event bus implementation
  • GraphQL: Functional GraphQL Client
  • HTTP: HTTP Utilities
  • Scheduler: Scheduling utility
  • State: Functional and persistent state machine implementation

Learning

In case you are not familiar with functional programming and you'd like to learn more about it, you can read up on the following resources:

Development

TODO

Publishing

In order to publish the underlying packages of this project you need to do the following:

  1. Install the dependencies using npm install
  2. Run the build script in script/build-all
  3. Log in to npm: npm login
  4. Navigate to the specific project in the dist directory and run npm publish --access public
  5. Bump all versions to the next one

You're done!