UNPKG

@altostra/core

Version:

Core library for shared types and logic

58 lines (42 loc) 1.67 kB
# Altostra Core Library Shared types and logic for Altostra's products and tools. ## Installing ```bash npm install @altostra/core ``` ## Usage After installing the library, each of its internal packages is accessible from `@altostra/core/lib/<packge-name>`. For example, you can import a type from the common package: ```typescript import { Blueprint } from '@altostra/core/lib/Blueprint' ``` After treeshaking, only the dependant packges are included. Currently available packages: - **aws** - AWS related types - **bizops** - Business logic and core operations - **blueprint** - Blueprint types and management - **common** - Common types and utilities - **deployments** - AWS deployments - **jwt** - JWT integrations - **telemetry** - Product telemetry and analytics ## Building Install dependencies: ```bash npm install ``` Use one of the following to build and test: ```bash npm run build # Build the library npm run build:force # Build the library. Ignore previous builds buildinfo. npm run build:watch # Build the library with watch mode. After any source # file is changed, the output is automatically # updated. npm run build:clean # Cleans the output directory. npm run build:rebuild # Cleans the output directry, and builds the library # ignoring previous buildinfo. npm run test # Test functionality of the entire package npm run test:watch # Test functionality of the entire package with watch # mode. After any source or test file is changed, # the tests are automatically run. ```