Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

kentico-cloud-delivery-node-sdk

Enngage13MITdeprecated1.2.0TypeScript support: included

Functionality of this package has been moved to kentico-cloud-delivery. Please install this latest version instead of using this package

Official Kentico Cloud Delivery SDK for node

Kentico, Kentico API, Kentico SDK, Kentico Cloud, Kentico Cloud SDK, Kentico Cloud Node, Kentico Cloud Node.js, Kentico Cloud Delivery, Kentico Cloud Delivery SDK, Kentico Delivery, Kentico Delivery SDK

readme

Kentico Cloud Delivery Node SDK

npm version Build Status npm Forums Coverage Status

An official client library for retrieving content from Kentico Cloud for Node.js

This library is based on Kentico Cloud Delivery TypeScript SDK. Visit this SDK for all examples & instructions on how to work with this library.

Scripts

  • Use npm test to run all tests.
  • Use npm run build to generate definitions & dist from the contents of lib folder.
  • Use update-sdk-info to run update SDK information by looking into package.json & writing it to a specialized file. This is picked up by delivery clients and used for identifying current SDK & version in request headers.

Publishing

In order to publish SDK first run one of following tasks to increase version & update sdk info file:

  • npm run new-patch
  • npm run new-minor
  • npm run new-major

And then run (note that tests and necessary scripts are automatically executed using the prepublishOnly script):

  • npm run publish

Feedback & Contribution

Feedback & Contributions are welcomed. Feel free to take/start an issue & submit PR.