cache-my-trash-sdk

Cache My Trash SDK

Description

SDK for Cache My Trash - simple key-value store with TTL.

Installation

npm install cache-my-trash-sdk

Using samples

Default connection

You can use SDK with default connection options. In this case SDK will try to connect to http://localhost:7701 (Cache My Trash service default).

// Import SDK.
import { CmtSdk } from 'cache-my-trash-sdk';

// Create instance of SDK.
const cmt = new CmtSdk();

// Add key-value pair.
await cmt.set('some-key', { foo: 'bar', baz: 123 });

// Add key-value pair with 60 seconds TTL.
await cmt.set('other-key-with-ttl', { foo: 'bar', baz: 456 }, 60);

// Get value by key.
const value = await cmt.get('some-key');
// Property `value` equals `{ foo: 'bar', baz: 123 }`.

// Delete key-value pair.
await cmt.delete('some-key');

Custom connection

You can pass custom connection options to SDK constructor.

// Create instance of SDK.
const cmt = new CmtSdk({
  host: 'localhost',
  port: 7701,
});

License

The MIT License (MIT)

Copyright © 2023 Volodymyr Sichka

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.