# @buttonize/toolkit

Latest version **1.0.2** (published 2023-03-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @buttonize/toolkit
pnpm add @buttonize/toolkit
yarn add @buttonize/toolkit
bun add @buttonize/toolkit
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-03-05 |
| First published | 2023-03-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 18 |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Buttonize |
| Maintainers | pyrek |
| Keywords | aws, ts, buttonize, typescript, serverless |

## Links

- npm: https://www.npmjs.com/package/@buttonize/toolkit
- Repository: https://github.com/buttonize/typescript-toolkit
- Homepage: https://github.com/buttonize/typescript-toolkit#readme
- Issues: https://github.com/buttonize/typescript-toolkit/issues
- npm.io page: https://npm.io/package/@buttonize/toolkit

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2023-03-05
- 1.0.1 — 2023-03-05
- 1.0.0 — 2023-03-05

## README

<p align="center">
  <a href="https://buttonize.io">
    <img width="350" alt="Buttonize.io" src="https://user-images.githubusercontent.com/6282843/212024942-9fd50774-ea26-48ba-b2cf-ca2584498c9a.png">
  </a>
</p>

---

<p align="center">
  <a href="https://discord.gg/2quY4Vz5BM"><img alt="Discord" src="https://img.shields.io/discord/1038752242238496779?style=flat-square" /></a>
  <a href="https://www.npmjs.com/package/@buttonize/toolkit"><img alt="npm" src="https://img.shields.io/npm/v/@buttonize/toolkit?style=flat-square" /></a>
  <a href="https://github.com/buttonize/typescript-toolkit/actions/workflows/release.yml?query=branch%3Amaster"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/buttonize/typescript-toolkit/release.yml?branch=master&style=flat-square" /></a>
</p>

[Buttonize](https://buttonize.io) is a low-code paltform which enables cloud developers to create UI widgets like buttons, inputs, forms etc. connected to the cloud services like [AWS Lambda](https://aws.amazon.com/lambda/), [AWS Step Functions](https://aws.amazon.com/step-functions/), [AmazonDynamoDB](https://aws.amazon.com/dynamodb/) and more.

This package contains TypeScript type definition for your lambda function handlers and other DX utilities.

## Getting started

### Installation

```
$ pnpm i -D @buttonize/toolkit
```

```
$ npm i -D @buttonize/toolkit
```

## Example

*You can find more examples in the [Buttonize AWS CDK constructs repository](https://github.com/buttonize/buttonize-cdk/tree/master/examples#examples).*

```typescript
// Lambda function handler file

import { ButtonizeHandler } from '@buttonize/toolkit'

export const handler: ButtonizeHandler<{
  email: string
  isAdmin: string
}> = async (event) => {
  console.log('save new user to database')

  return {
    format: 'text',
    body: 'User created.'
  }
}
```

## Buttonize Docs

Learn more at [docs.buttnoize.io](https://docs.buttonize.io)

---

**Join our community** [Discord](https://discord.gg/2quY4Vz5BM) | [Twitter](https://twitter.com/SST_dev)

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