# apitoolkit-js

> share code for all js web framework apitoolkit sdks

Latest version **3.3.3** (published 2024-07-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install apitoolkit-js
pnpm add apitoolkit-js
yarn add apitoolkit-js
bun add apitoolkit-js
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.3.3 |
| Published | 2024-07-16 |
| First published | 2022-08-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 193.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Maintainers | apitoolkit |

## Links

- npm: https://www.npmjs.com/package/apitoolkit-js
- Repository: https://github.com/apitoolkit/apitoolkit-js
- Homepage: https://github.com/apitoolkit/apitoolkit-js#readme
- Issues: https://github.com/apitoolkit/apitoolkit-js/issues
- npm.io page: https://npm.io/package/apitoolkit-js

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.6.2
- [jsonpath](https://npm.io/package/jsonpath.md) ^1.1.1

## Recent versions

- 3.3.3 (latest) — 2024-07-16
- 3.3.2 — 2024-06-08
- 3.3.1 — 2024-06-07
- 3.3.0 — 2024-06-07
- 3.2.9 — 2024-04-14
- 3.2.8 — 2024-04-14
- 3.2.7 — 2024-04-14
- 3.2.6 — 2024-04-14
- 3.2.5 — 2024-04-14
- 3.2.4 — 2024-04-14
- 3.2.3 — 2024-04-01
- 3.1.3 — 2024-04-01
- 3.0.3 — 2024-03-14
- 3.0.2 — 2024-03-13
- 2.0.2 — 2023-12-14
- … 6 more at https://npm.io/package/apitoolkit-js/versions

## README

<div align="center">

![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-white.svg?raw=true#gh-dark-mode-only)
![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-black.svg?raw=true#gh-light-mode-only)

## Javascript SDKs Shared Code

[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=javascript)](https://github.com/topics/apitoolkit-sdk) [![](https://img.shields.io/npm/v/apitoolkit-js.svg?logo=npm)](https://npmjs.com/package/apitoolkit-js) [![](https://img.shields.io/npm/dw/apitoolkit-js
)](https://npmjs.com/package/apitoolkit-js) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) 

APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS framework SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) or directly use this `apitoolkit-js` package (the shared code for all the Javascript SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.

</div>

---

## Table of Contents

- [Installation](#installation)
- [Configuration](#configuration)
- [Contributing and Help](#contributing-and-help)
- [License](#license)

---

## Installation

Kindly run the command below to install this package:

```sh
npm install apitoolkit-js
```

## Configuration

Next, initialize APItoolkit in your application's entry point (e.g., `index.js`), like so:

```js
import { APIToolkit, ReportError, observeAxios } from "apitoolkit-js";

const apiToolkitClient = APIToolkit.NewClient({
  apiKey: "{ENTER_YOUR_API_KEY_HERE}",
  debug: false,
  tags: ["environment: production", "region: us-east-1"],
  serviceVersion: "v2.0",
});

...
```

> [!NOTE]
> 
>  - The `{ENTER_YOUR_API_KEY_HERE}` demo string should be replaced with the [API key](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.
> - To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read any of the [NodeJS SDK documentation](https://apitoolkit.io/docs/sdks/nodejs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).

## Contributing and Help

To contribute to the development of this PROJECT or request help from the community and our team, kindly do any of the following:
- Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).
- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-js/issues/new/choose) in this repository.

## License

This repository is published under the [MIT](LICENSE) license.

---

<div align="center">
    
<a href="https://apitoolkit.io?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme" target="_blank" rel="noopener noreferrer"><img src="https://github.com/apitoolkit/.github/blob/main/images/icon.png?raw=true" width="40" /></a>

</div>

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