Skip to content

Latest commit

 

History

History
122 lines (81 loc) · 3.62 KB

DOCINDEX.md

File metadata and controls

122 lines (81 loc) · 3.62 KB
Raw

Okuna.js Documentation

Welcome to the Okuna.js documentation page! Okuna.js is a JavaScript library that allows you to interact with the Okuna API. It can be used both in the browser and in Node.js.

Getting Started

Node.js

The first thing you need to do is to install the package. To do this, you can either run

npm i okuna

or, if you prefer Yarn:

yarn add okuna

Depending on your setup, you want to use one of these:

CommonJS:

const { Client } = require('okuna');
const client = new Client();

const health = await client.health().getHealth();

ES6 imports:

import { Client } from 'okuna';
const client = new Client();

const health = await client.health().getHealth();

Browser

If you use a bundler (e.g.: Webpack)

The process is nearly identical to the one of Node.js. Install the library using the steps described in the Node.js setup and use the ES6 imports method for working with the library.

If you don't use a bundler

Import the bundled and minified script from the JSDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/okuna.min.js"></script>

This will register the Okuna variable in your website's DOM. You can use the library like this:

const { Client } = Okuna;
// or const client = new Okuna.Client();

const client = new Client();

const health = await client.health().getHealth();
// Note: older browsers don't support async/await.

Note: The okuna.min.js file has additional dependencies bundled in. These dependencies include Axios, isomorphic-fetch, and isomorphic-form-data to ensure that the library works. You may or may not have one or more of these libraries loaded in your web page already. Unless you know what you doing, you should use a bundler to reduce the size of your assets, have a better development experience, and remove potential conflicts.

Working With the Library

This web page contains a documentation on how exactly the API of the library works and how you should use it in your projects. You should start by reading more about the Okuna.js Client class.

Working With Files/Uploads

It is very important to know how to work with file uploads when using the library. File uploads are done using the multipart/form-data header, so we use FormData to create a payload to be sent to the API server.

When passing a file as a parameter, it should always have these two parameters:

  • file - A blob or file input object
  • name - The name of the file

Example (Node.js):

const fs = require('fs');
const { Client } = require('okuna');

// ... client setup

const blob = fs.readFileSync('/path/to/file');

client.posts().createPost({
  text: 'Here is an image!',
  image: {
    file: blob,
    name: 'filename_with.extension' // if you know the path, you should know the name too (you can use path.basename() here)
  }
})
  .then(res => console.log(res))
  .catch(err => console.error(err));

Example (file inputs):

// ... client setup

const fileInput = document.querySelector("input[name=image]");

client.posts().createPost({
  text: 'Here is an image!',
  image: {
    file: fileInput.files[0], // you'd probably store fileInput.files[0] in a separate variable
    name: fileInput.files[0].name
  }
})
  .then(/* ... */)
  .catch(/* ... */);

Questions?

Feel free to open an issue in the library's Github repository.