# kvpbase-sdk-js-node

> NodeJS SDK for kvpbase - http://www.kvpbase.com

Latest version **1.0.7** (published 2015-11-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install kvpbase-sdk-js-node
pnpm add kvpbase-sdk-js-node
yarn add kvpbase-sdk-js-node
bun add kvpbase-sdk-js-node
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2015-11-24 |
| First published | 2015-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kevin Swartz |
| Maintainers | kvpbase |
| Keywords | kvpbase, sdk, js, node, storage, server |

## Links

- npm: https://www.npmjs.com/package/kvpbase-sdk-js-node
- Repository: https://github.com/kvpbase/kvpbase-sdk-js-node
- Issues: https://github.com/kvpbase/kvpbase-sdk-js-node/issues
- npm.io page: https://npm.io/package/kvpbase-sdk-js-node

## 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

- 1.0.7 (latest) — 2015-11-24
- 1.0.6 — 2015-08-03
- 1.0.5 — 2015-08-03
- 1.0.4 — 2015-07-20
- 1.0.3 — 2015-07-20
- 1.0.2 — 2015-07-20
- 1.0.1 — 2015-07-20
- 1.0.0 — 2015-07-20

## README

# Node/Javascript SDK for kvpbase

kvpbase is a data storage platform for developers and sysadmins that allows
you to quickly deploy an elastic object storage cloud with near-infinite 
key-value storage on your own machines within minutes.  This SDK is intended 
to help you quickly integrate kvpbase into your application.

    npm install kvpbase-sdk-js-node

## Before you begin

- Visit www.kvpbase.com to set up account, obtain your license keys, and 
  download the kvpbase binaries to deploy on your own machines

- This SDK is designed for integration into web or backend apps.  It is not 
  recommended that it be used in apps where the user will have access to
  your credentials or API keys

- If you use the public kvpbase test servers to test the SDK, be aware that
  user data is expired and deleted daily

- This SDK is designed for environments using Node.JS

## Getting started

Please refer to kvpbase-sdk-js-test.js for a sample GET request using the SDK

Modify the SDK file to include your API key and the details for the kvpbase server (hostname, port, SSL)

Within your application, add a require statement for the SDK:
```
var kvp = require('kvpbase-sdk-js.js');
```

Perform the following operations using the SDK.

  Retrieve an object by ID
```
  	kvp.kvpbase_read_obj(
  	  'object_name', 
  	  callback(err, data) { /* your function here */ });
```

  Create an object (system-assigned name)
```
  	kvp.kvpbase_write_obj(
  	  'object data here', 
  	  'content-type here',
  	  callback(err, data) { /* your function here */ });
```

  Create an object (user-assigned name)
```
  	kvp.kvpbase_write_inplace_obj(
  	  'object data here', 
  	  'content-type here',
  	  'desired object name',
  	  callback(err, data) { /* your function here */ });
```

Verify Object Exists
```
    kvp.kvpbase_obj_exists(
      'object_name', 
      callback(err, data) { /* your function here */ });
```

  Rename Object
```
    kvp.kvpbase_rename_obj(
      'path/to/container',
      'object_name', 
      'new_object_name',
      callback(err, data) { /* your function here */ });
```

  Move Object
```
    kvp.kvpbase_move_obj(
      'path/to/container',
      'object_name', 
      'path/to/different/container',
      'new_object_name',
      callback(err, data) { /* your function here */ });
```

  Delete an object
```
  	kvp.kvpbase_del_obj(
  	  'object_name', 
  	  callback(err, data) { /* your function here */ });
```

  Retrieve folder metadata
```
  	kvp.kvpbase_read_obj(
  	  callback(err, data) { /* your function here */ });
```

  Rename Container
```
    kvp.kvpbase_rename_container(
      'path/to/container',
      'container_name', 
      'new_container_name',
      callback(err, data) { /* your function here */ });
```

  Move Container
```
    kvp.kvpbase_move_container(
      'path/to/container',
      'container_name', 
      'path/to/different/container',
      'new_container_name',
      callback(err, data) { /* your function here */ });
```

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