@monagoio/monagojs
TypeScript icon, indicating that this package has built-in type declarations

1.0.18 • Public • Published

MonagoJS - Fast And Customized APIs Library From Monago.io

Maintainability Rating Reliability Rating npm version npm downloads

SDK for monago platform, help developers to create and consume apis without managing the fullcode and its infrastructure

Note: This library is only meant for usage from server-side with Monago secret API key. For PCI compliance to be maintained, tokenization of apis url info should be done on client side with monago dashboard.

Usage

First, you need to install the library

$ npm install @monagoio/monagojs

or

$ yarn add @monagoio/monagojs

Then, you create a project through Monago dashboard to get a secretKey to grant the access for the client application.

import { MonagoClient } from '@monagoio/monagojs'

const client = new MonagoClient({
  secretKey: "*******"
})

How to Use

There are basic usages for developers to leverage Monago SDK such as register, login, create, read, update, delete. Remember, define you model and data through Monago dashboard.

Example

Register

To use register function, you can pass your data such as below.

client.register({ email: "monago@example.com", name : "monago", password: "pass" })

Login

To use login function, you can pass your data such as below.

client.login({ email : "monago", password: "pass" })

Create

To use create function, you can pass your data such as below.

client.post({ url: "/todos", data: {
    "name": "Build an app",
    "description": "Awesome apps ready to be released",
    "date": "2022-05-18T08:51:52.031Z"
}})

Read All

To use read all function, you can write the code such as below.

client.get({ url: "/todos", params: {
    "page": 1,
    "limit": 10,
    "orderby": "date"
}})

But, it depends whether you check the pagination option when you create the data model. If you uncheck the pagination, you can delete the params.

Read Detail

To use read function, you can write the code such as below.

client.get({ url: "/todos/:id" })

Update

To use update function, you can pass your data such as below.

client.put({ url: "/todos/:id", data: {
    "name": "[Postponed] Build an app",
    "description": "Awesome apps ready to release",
    "date": "2022-06-18T08:51:52.031Z"
}})

Delete

To use delete function, you can write the code such as below.

client.delete({ url: "/todos/:id" })

Remember, the URL depends on the model that you've defined.

Upload

To use upload function, you can write the code such as below.

client.upload({ url: "/upload" (optional), file, /folder/nama_file(optional)})

Package Sidebar

Install

npm i @monagoio/monagojs

Weekly Downloads

0

Version

1.0.18

License

MIT

Unpacked Size

32 kB

Total Files

49

Last publish

Collaborators

  • huseindra
  • ibidathoillah