Skip to content

collective/plone-restapi-client

Repository files navigation

Plone REST API Client

npm version Tests TypeScript

A wrapper for plone.restapi for browser and nodejs needs.

This library contains methods and typings to interact with the Plone REST API, giving you the power to create and manage content in Plone, with the strength and DX of TypeScript support.

Every method has JSDoc annotations with usage and description and typings information for parameters and return values.

Install

npm install --save plone-restapi-client
yarn add plone-restapi-client

Usage

import { client, content } from 'plone-restapi-client';

client.init('http://localhost:8080/Plone');

client.auth('admin', 'admin').then(() => {
  content.get('/my-page').then(console.log);
});

Development

See DEVELOPMENT.md