# ripe-config-api

> The RIPE Config API client

Latest version **0.1.1** (published 2022-01-24) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install ripe-config-api
pnpm add ripe-config-api
yarn add ripe-config-api
bun add ripe-config-api
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2022-01-24 |
| First published | 2022-01-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 565.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Platforme |
| Maintainers | platforme |
| Keywords | api, client, config, js, ripe |

## Links

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

## Dependencies (1)

- [yonius](https://npm.io/package/yonius.md) ^0.8.3

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.1.1 (latest) — 2022-01-24
- 0.1.0 — 2022-01-24

## README

# RIPE Config API for Javascript

Simple Javascript API client for RIPE Config.

## Example

```javascript
import { API as ConfigAPI } from "ripe-config";
await ConfigAPI.load();
const api = new ConfigAPI({
    username: "YOUR_USERNAME",
    password: "YOUR_PASSWORD"
});
console.info(await api.getResource("info.json"));
```

## Configuration

| Name                     | Type  | Default                         | Description                                             |
| ------------------------ | ----- | ------------------------------- | ------------------------------------------------------- |
| **RIPE_CONFIG_BASE_URL** | `str` | `https://config.platforme.com/` | The base URL to the RIPE ID server instance to be used. |
| **RIPE_CONFIG_USERNAME** | `str` | `null`                          | The username to be used for authentication.             |
| **RIPE_CONFIG_PASSWORD** | `str` | `null`                          | The password to be used for authentication.             |

## License

RIPE Config API Javascript is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).

## Build Automation

[![Build Status](https://github.com/ripe-tech/ripe-config-api-js/workflows/Main%20Workflow/badge.svg)](https://github.com/ripe-tech/ripe-config-api-js/actions)
[![npm Status](https://img.shields.io/npm/v/ripe-config-api.svg)](https://www.npmjs.com/package/ripe-config-api)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/)

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