npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@alwatr/storage-client

v4.0.0-rc.0

Published

Elegant micro client for storage server written in tiny TypeScript ES module.

Downloads

52

Readme

Alwatr Storage Client - @alwatr/storage-client

Elegant micro client for storage server written in tiny TypeScript ES module.

Example usage

import {type AlwatrDocumentObject, AlwatrStorageClient} from '@alwatr/storage-client';

type User = AlwatrDocumentObject & {
  email: string;
  token?: string;
};

const db = new AlwatrStorageClient<User>({
  name: 'user-list',
  host: '127.0.0.1',
  port: 9000,
  token: 'YOUR_SECRET_TOKEN',
  timeout: 2_000,
});

await db.set({
  id: 'alimd',
  email: '[email protected]',
});

await db.set({
  id: 'fmd',
  email: '[email protected]',
  token: Math.random().toString(36).substring(2, 15),
});

console.log("has 'alimd': %o", await db.has('alimd'));
console.log('keys: %o', await db.keys());
console.log('getAll: %o', await db.getAll());
console.log('delete: %o', await db.delete('alimd'));
try {
  await db.delete('abcd');
} catch (err) {
  console.log('delete 404: %o', (err as Error).message);
}

API

config.name: string

Storage name (like database name).

config.host: string

Storage server host name (URL).

config.token: string

Storage server token (like database password).

config.timeout?: number

A timeout in ms for the fetch request.

config.debug?: boolean

Debug output logs.

get(documentId: string): Promise<DocumentType>

Get a document object by id.

  • documentId: The id of the document object.

Example:

try {
  const user = await userStorage.get('user-1');
  console.dir(item);
} catch (err) {
  if ((err as Error)?.message === 'document_not_found') {
    console.log('user_5000 id not found!');
  } else {
    console.error(err);
  }
}

has(documentId: string): Promise<boolean>

Check document exists by id.

  • documentId: The id of the document object.

Example:

const userExist = await userStorage.has('user-1');
if (!userExist) console.log('user_not_found');

set(documentObject: DocumentType, fastInstance?: boolean): DocumentType

Insert/update a document object in the storage.

  • documentObject: The document object to insert/update contain id.

Example:

userStorage.set({
  id: 'user-1',
  foo: 'bar',
});

delete(documentId: string): Promise<void>

Delete a document object from the storage.

Example:

userStorage.delete('user-1');

getStorage(): Promise<AlwatrDocumentStorage>

Dump all storage data.

Example:

const userStorage = await userStorage.getStorage();