# @busieinc/types

> Common Typescript Types across the Busie Platform

Latest version **1.0.1** (published 2022-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @busieinc/types
pnpm add @busieinc/types
yarn add @busieinc/types
bun add @busieinc/types
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-05-16 |
| First published | 2022-03-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Brady Perry |
| Maintainers | diokhan, alexanderkrivonosov_pv, parkh, chalk.busie, bperry |
| Keywords | types, busie, busieinc |

## Links

- npm: https://www.npmjs.com/package/@busieinc/types
- Repository: https://bitbucket.org/busie/busieinc-types
- Homepage: https://bitbucket.org/busie/busieinc-types#readme
- Issues: https://bitbucket.org/busie/busieinc-types/issues
- npm.io page: https://npm.io/package/@busieinc/types

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2022-05-16
- 1.0.0 — 2022-03-21

## README

# Busie Types NPM Package

## Installation
`npm run --save-dev @busieinc/types`

## Contributing
### Note:
Contrary to the steps outlined below, testing is not really possible at this time, due to the steps needed to actually publish the package.
These steps are the desired contribution steps, however, since testing is not possible, it will be necessary to manually test when contributing temporarily
1. Clone the Repository
2. Change directory into project root
3. Check out a new branch `types/the-type-you-will-add`
4. Run Tests *first* (or lint, it's the same thing)
 `npm run test` or `npm run lint`
5. Add your types and interfaces to index.d.ts
6. Add tests to busie-tests.ts (basically just examples of how the types should work/be used)
7. Run Tests again
 `npm run test` or `npm run lint`
8. Assuming everything works, create a pull request!

###### Note: To keep it simple for now, we'll not add any automation for NPM publishing. Brady will publish new types manually for the time being

---
_Source: https://npm.io/package/@busieinc/types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._