# dewy-ts

> Typescript client for Dewy

Latest version **0.4.0** (published 2024-03-07) · 0 weekly downloads

## Install

```sh
npm install dewy-ts
pnpm add dewy-ts
yarn add dewy-ts
bun add dewy-ts
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2024-03-07 |
| First published | 2024-02-14 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 62.5 KB |
| Known vulnerabilities | 0 (+28 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Maintainers | kerinin |

## Links

- npm: https://www.npmjs.com/package/dewy-ts
- Repository: https://github.com/DewyKB/dewy-ts
- Homepage: https://github.com/DewyKB/dewy-ts#readme
- Issues: https://github.com/DewyKB/dewy-ts/issues
- npm.io page: https://npm.io/package/dewy-ts

## Dependencies (5)

- [pnpm](https://npm.io/package/pnpm.md) ^8.15.4
- [form-data](https://npm.io/package/form-data.md) ^4
- [langchain](https://npm.io/package/langchain.md) ^0.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^3
- [@scarf/scarf](https://npm.io/package/@scarf/scarf.md) ^1.3.0

## Recent versions

- 0.4.0 (latest) — 2024-03-07
- 0.3.0 — 2024-03-04
- 0.2.1 — 2024-02-22
- 0.2.0 — 2024-02-15
- 0.1.4 — 2024-02-14

## README

# Typescript/Javascript Dewy SDK

## Installing

1. Install the library
```sh
npm install dewy-ts
```
1. Connect to a Dewy instance
```typescript
import { Dewy } from 'dewy-ts';
const dewy = new Dewy({endpoint: “localhost:3000”})
```

For more information about how to use Dewy, see the [README in the main repo](https://github.com/DewyKB/dewy).

## Cutting a new release

1. Setup development environment
    ```sh
    npm install
    ```
1. Run the Dewy service
    ```sh
    docker run dewykb/dewy
    ```
1. Regenerate the client library
    ```sh
    rm -rf src/client
    openapi --name Dewy -c fetch --input ../dewy/openapi.yaml --output ./src/client --useUnionTypes
    ```
1. Recompile Typescript
    ```sh
    rm -rf dist && npx tsc
    ```
1. Publish to npm
    (You probably want to bump the version number in `package.json` first)

    ```sh
    npm publish --access public
    ```

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=bafcdbae-2a13-4b8b-a31b-bbe8d9eb1ca9" />

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