Important

Using the noonjs Client is totally optional. Feel free to interact with the backend the old-school way via REST & Socket.IO.

Clients

JS

The noonjs Client is a TypeScript-based library designed to seamlessly interact with the noonjs backend. It eliminates the need for manual API calls by automatically generating request methods based on the defined schemas in config.json.

Installation

To install the noonjs Client, use npm, yarn, or pnpm:

How to use

import Client from "noonjs-client";

const client = new Client({ server: "https://localhost:5000" }); // my-noon-server

Server property is optional

Some CRUD

Define the 'todos' collection in config.json, ensuring that the permissions property is set to * to grant full access.

{
    "collections": {
        "todos": {
            "schema": {
                "title": {
                    "type": "string"
                },
                "done": {
                    "type": "number"
                }
            },
            "permissions": {
                "*": true
            }
        }
    }
}

To add a new todo item to the 'todos' collection using the noonjs client, use the following command. This example adds a todo with the title 'Buy milk'.

const todo = await client.collection("todos").post({ title: "Buy milk" });

To fetch all todo items from the 'todos' collection using the noonjs client, use the following command. Need more details on pagination?

const todos = await client.collection("todos").get();

React

Building something epic here. Sorry for the dust, we’ll clean up when we’re done!

Vue

Client under construction: We’ve got builders, architects, and a few squirrels working on this!

Nuxt

Warning: This client is under construction. Proceed with caution. Magic is happening!