Chastikey-js NPM

chastikey-js

How to install

Yarn

yarn add chastikey-js

NPM

npm i chastikey-js

Usage

`ChastiKey`

Available Options:

Key	Accepts Type(s)	Default	Available/Example
baseURL	`string`	`https://chastikey.com`
repo	`string`	`api`	`api`, `json`
apiVersion	`string`	`v0.4`	`v0.2`, `v0.3`, `v0.4`, (`1.0`*)

*1.0 - is only for the JSON exports, NOT for regular lookups.

`ChastiKey.ListLocks`

Retrieves the specified user's locks.

ChastiKey Side Caching: [ Yes ] [ 60 Seconds ]

Available Options:

Key	Required?	Accepts Type(s)	Default
username	Yes	`string`
showdeleted	No	`boolean`	`false`
bot	No	`string`

API Usage:

const ll = await new ChastiKey().ListLocks.get({ username: 'username' })
const ll = await new ChastiKey().ListLocks.getByUsername('username')

ll // => { status: 200, locks: Array<ListLocksLock>, ... }

`ChastiKey.Ticker`

Creates the URL string to the user's Ticker.

ChastiKey Side Caching: [ No ]

Available Options:

Key	Required?	Accepts Type(s)	Available/Example
username	Yes	`string`
type	Yes	`string`	`Lockee`, `Keyholder`
show5StarRating	Yes	`boolean`
optional	No	`object`
`optional.startDate`	No	`object`	`{ day: '01', month: '01', year: '2019'}`
`optional.fileExt`	No	`string`	`jpg` ,`png` , `gif`
`optional.addTimestamp`	No	`boolean`

API Usage:

const ticker = new ChastiKey.Ticker.getURL({
  username: 'UsernameHere',
  type: 'Keyholder',
  show5StarRating: false,
  optional: { fileExt: 'png' }
})

ticker // => "https://chastikey.com/tickers/ticker.php?ty=1&un=UsernameHere&r=0&ext=.png"

License

MIT

axios

1.0.0

5 years ago