Skip to content

contentful/contentful-sdk-core

Repository files navigation

contentful-sdk-core

MIT License NPM Version npm downloads js-standard-style semantic-release Commitizen friendly

This package contains some core modules and utilities used by both the contentful.js and contentful-management.js SDKs.

About

Contentful provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.

Installation

npm install --saveDev contentful-sdk-core

Use case

This package contains some core modules and utilities used by both the contentful.js and contentful-management.js SDKs.

Support

This repository is compatible with Node.js version 18 and later. It exclusively provides an ECMAScript Module (ESM) variant, utilizing the "type": "module" declaration in package.json. Users are responsible for addressing any compatibility issues between ESM and CommonJS (CJS).

Types

TypeScript definitions for this repository are available through the "types" property in package.json.

Development

Create the default and the es-modules build:

npm run build

Run Tests:

Run only the unit tests:

npm run test

Run unit tests including coverage report:

npm run test:cover