clauneck
A library that interacts with the Clauneck API
Last updated 9 months ago by nilaeus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install clauneck 
SYNC missed versions from official npm registry.

Clauneck

npm version codecov codebeat badge Greenkeeper badge MIT Build

Easy data for everyone, from everywhere. ????

Getting Started

Follow these simple instructions to get set up and ready to use Clauneck.

Via npm ????

npm is the package manager for javascript

Read about npm here ????

(I personally like using yarn ???? )

View the NPM page for Clauneck here ????

Installing

Install Clauneck just like any other package: ????

With NPM:

npm i -s clauneck

With Yarn:

yarn add clauneck

And use it:

const clauneck = require('clauneck');

Or, with TypeScript

import * as clauneck from 'clauneck'

or commands individually

import { users, get } from 'clauneck'

Usage

Assuming that clauneck is assigned to the clauneck variables ????

These all return promises and were created using async/await! ❤️

clauneck.get()

Gets data from a user ????

clauneck.get(
    path: string,
    options?: object
);

clauneck.set()

Merges, updates data ????

clauneck.set(
    path: string,
    psk: string,
    newData: any,
    options?: object
);

clauneck.clnk()

Sends a request to the Clauneck API

clauneck.clnk(
    cmd: string
    params?: object
);

clauneck.users()

Get the users! ????

clauneck.users();

clauneck.create()

Creates a new user ????

clauneck.create(
    name: string,
    psk: string
);

clauneck.psk()

Changes a user's password ????

clauneck.psk(
    handle: string,
    oldPsk: object,
    newPsk: object
);

clauneck.name()

Changes a user's name ????

clauneck.name(
    handle: string,
    psk: string,
    newName: string
);

clauneck.user()

Gets a user's id and name ❓

clauneck.user(
    handle: string
);

clauneck.check()

Checks a user's handle and password combo ????

clauneck.check(
    handle: string,
    psk: string
);

clauneck.exists()

Checks if a user exists ????

clauneck.exists(
    handle: string
);

clauneck.safeName()

⚠️ Returns a string, not a promise!

This makes a name safe for clauneck.

clauneck.safeName(
    name: string
);

clauneck.safeHandle()

⚠️ Returns a string, not a promise!

This makes a proper handle for clauneck.

clauneck.safeHandle(
    handle: string
);

Wrapping Up

Clauneck is an easy to use database for your data. ????

If you catch something or want to work on Clauneck, it is open-sourced on GitHub!

Thanks for reading. ????????

Current Tags

  • 0.1.12                                ...           latest (9 months ago)

27 Versions

  • 0.1.12                                ...           9 months ago
  • 0.1.11                                ...           9 months ago
  • 0.1.10                                ...           9 months ago
  • 0.1.9                                ...           10 months ago
  • 0.1.8                                ...           10 months ago
  • 0.1.7                                ...           a year ago
  • 0.1.6                                ...           a year ago
  • 0.1.5                                ...           a year ago
  • 0.1.4                                ...           a year ago
  • 0.1.3                                ...           a year ago
  • 0.1.2                                ...           a year ago
  • 0.1.1                                ...           a year ago
  • 0.1.0                                ...           a year ago
  • 0.0.9                                ...           a year ago
  • 0.0.8                                ...           a year ago
  • 0.0.7                                ...           a year ago
  • 0.0.6                                ...           a year ago
  • 0.0.5                                ...           a year ago
  • 0.0.4                                ...           a year ago
  • 0.0.3                                ...           a year ago
  • 0.0.2                                ...           a year ago
  • 0.0.1                                ...           2 years ago
  • 0.0.0                                ...           2 years ago
  • 1.0.3                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 27
Last Day 0
Last Week 0
Last Month 28
Dependencies (1)
Dev Dependencies (7)
Dependents (2)

Copyright 2014 - 2016 © taobao.org |