npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

contensis-delivery-api

v1.4.0

Published

Contensis Javascript Delivery API

Downloads

4,566

Readme

contensis-delivery-api NPM version

Contensis JavaScript Delivery API implementation written in TypeScript.

This allows the querying and retrieval of entries, content types and projects in JavaScript.

It can be used in any ES5 compatible project.

  • JavaScript/TypeScript code running in a browser
  • JavaScript/TypeScript code running in Node.js
  • Angular
  • React
  • React Native
  • NativeScript
  • Node.js
  • Express

The contensis-delivery-api-examples repo contains Express, React and Angular test applications, as well as a Node.js nodes api extended example.

Installation

The Contensis JavaScript Delivery API can be installed using npm.

npm install contensis-delivery-api

Contensis support

This version supports Contensis releases from 12.0 and above. For Contensis 11.3 support use this version .

Examples

Using ES2015 async/await

import { Client } from 'contensis-delivery-api';

let contensisConfig = { 
	rootUrl: 'https://my-cms.com',
	accessToken: 'MY_DELIVERY_API_ACCESS_TOKEN',
	projectId: 'MY_PROJECT_ID',
	language: 'en-GB',
	versionStatus: 'published',
	pageSize: 50
};

async function loadMovies() {
	let client = Client.create(contensisConfig);
	let movieList = await client.entries.list({
		contentTypeId: 'movie',
		pageOptions: { pageIndex: 0, pageSize: 10 },
		orderBy: ['-releaseDate']
	});
	console.log(movieList.items);
}

loadMovies();

Using Promises

import { Client } from 'contensis-delivery-api';

let contensisConfig = { 
	rootUrl: 'https://my-cms.com',
	accessToken: 'MY_DELIVERY_API_ACCESS_TOKEN',
	projectId: 'MY_PROJECT_ID',
	language: 'en-GB',
	versionStatus: 'published',
	pageSize: 50
};

function loadMovies() {
	let client = Client.create(contensisConfig);
	client.entries.list({
		contentTypeId: 'movie',
		pageOptions: { pageIndex: 0, pageSize: 10 },
		orderBy: ['-releaseDate']
	}).then(movieList => {
		console.log(movieList.items);
	});
}

loadMovies();

Documentation

Read our documentation on the Contensis Javascript Delivery API to learn of all it's features.

Browser support

This library relies on the fetch API being available at runtime. In modern browsers fetch is available natively, and a polyfill is provided for older browsers. The library build that targets browsers can be found in the bundle folder.

Node.js support

The library supports Node.js 8 and above.
When using this library in Node.js you need to add the node-fetch npm package as a dependecy and ensure fetch is registered as a global function:

global.fetch = require("node-fetch");