0.1.4 • Published 6 years ago
@poetapp/frost-client v0.1.4
Frost Client
The Frost Client helps easily integrate your applications with the Frost API.
Index
Gitter
For any questions about developing an application that integrates with Frost or contributing to Po.et that aren't answered here check out our Gitter community at https://gitter.im/poetapp.
Getting Started
Install
Install Frost Client from the NPM repository or directly from this GitHub repository:
$ npm install @poetapp/frost-client
$ yarn add @poetapp/frost-client
$ git clone git@github.com:poetapp/frost-client.git
$ cd frost-client && npm link
Import
import { Frost } from '@poetapp/frost-client'
const { Frost } = require('@poetapp/frost-client')
Initialize
import { Frost } from '@poetapp/frost-client'
const config = {
host: 'https://api.frost.po.et', // required
timeout: 10 // default 10 seconds
}
const frost = new Frost(config)
Methods
Create Work
Returns a promise with Frost's response. Throws in case of errors.
async function createWork() {
try {
const work = {
name: 'My first work in Frost',
datePublished: '2017-11-24T00:38:41.595Z', // ISO date
dateCreated: '2017-11-24T00:38:41.595Z', // ISO date
author: 'Me'
tags: 'Frost,the best', // tags separation by commas
content: 'The best content'
}
const { workId } = await frost.createWork(token, work)
} catch(e) {
console.log(e)
}
}
createWork()
Get Work By ID
Returns a promise with Frost's response. Throws in case of errors.
async function getWork () {
try {
const workId = '123456'
const work = await frost.getWork(token, workId)
} catch(e) {
console.log(e)
}
}
getWork()
Get All Works
Returns a promise with Frost's response. Throws in case of errors.
const getAllWorks = async () => {
try {
const works = await frost.getWorks(token)
} catch(e) {
console.log(e)
}
}
getAllWorks()