# @zettelyay/api-client

> Zettel: Public API types and access for client-side code

Latest version **4.2.1** (published 2023-05-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install @zettelyay/api-client
pnpm add @zettelyay/api-client
yarn add @zettelyay/api-client
bun add @zettelyay/api-client
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.2.1 |
| Published | 2023-05-16 |
| First published | 2023-05-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 23.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Zettel |
| Maintainers | zettelyay |
| Keywords | zettel, client, api |

## Links

- npm: https://www.npmjs.com/package/@zettelyay/api-client
- Repository: https://github.com/zettelyay/api-client
- Homepage: https://github.com/zettelyay/api-client#readme
- Issues: https://github.com/zettelyay/api-client/issues
- npm.io page: https://npm.io/package/@zettelyay/api-client

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 4.2.1 (latest) — 2023-05-16
- 4.2.0 — 2023-05-16
- 4.1.0 — 2023-05-16
- 4.0.0 — 2023-05-14
- 3.0.0 — 2023-05-13
- 2.0.0 — 2023-05-13
- 1.0.1 — 2023-05-06
- 1.0.0 — 2023-05-02

## README

# Zettel: Public API Client

API helper tools for client-side.

## Installation

```bash
$ npm install @zettelyay/api-client
```

## Development

Clone the repository locally:


```bash
$ git clone https://github.com/zettelyay/api-client.git
```

Install the dependencies:

```bash
$ cd api-client
$ npm install
```

It's recommended to use **VS Code** to develop this project.
You need to have **Prettier** and **ESLint** extensions to be installed on your IDE.

> Linting will be called _automatically_ before committing. Any linting error will abort the process. Therefore, you possibly need to lint the staged changes manualy before trying to commit them yourself and fix all the errors and as much as possible of warnings first.

Lint check before commit:

```bash
$ npm run lint-staged   # Alternatively:   $ npm run .l
```

## Publication

Publish a new version of the NPM package:

- Push all the changes. The workspace needs to be cleaned.
- Make sure you're on `master` branch.

```bash
$ npm version patch   # / minor / major / any other valid semantic version
```

## Misc

Validate all peer dependencies:

```bash
$ npm run peers.validate
```

Upgrade all Zettel's official dependencies:

```bash
$ npm run zettel.upgrade   # Alternatively:   $ npm run .u
```

Check for all the updates available on the dependencies:

```bash
$ npm run updates.check
```

Upgrade all the dependencies to their very latest versions:

```bash
$ npm run updates.install
```

View GIT history visualized:

```bash
$ npm run gource
```

> You probably need to install `gource` locally first.<br/>
See [this link](https://gource.io/).

Summarize the size of the code base in lines of code:

```bash
$ npm run status
```

------------------

Copyright: **Zettel, 2020-23**

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