https://github.com/contentful/contentful-sdk-core
Core modules for the Contentful JS SDKs
https://github.com/contentful/contentful-sdk-core
contentful sdk sdk-core
Last synced: about 1 month ago
JSON representation
Core modules for the Contentful JS SDKs
- Host: GitHub
- URL: https://github.com/contentful/contentful-sdk-core
- Owner: contentful
- License: mit
- Created: 2016-04-19T08:29:34.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T18:45:42.000Z (about 1 month ago)
- Last Synced: 2025-04-12T19:52:10.910Z (about 1 month ago)
- Topics: contentful, sdk, sdk-core
- Language: TypeScript
- Homepage:
- Size: 826 KB
- Stars: 23
- Watchers: 56
- Forks: 22
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# contentful-sdk-core

[](https://www.npmjs.com/package/contentful-sdk-core)
[](http://npm-stat.com/charts.html?package=contentful-management)
[](https://github.com/feross/standard)
[](https://github.com/semantic-release/semantic-release)
[](http://commitizen.github.io/cz-cli/)> This package contains some core modules and utilities used by both the [contentful.js](https://github.com/contentful/contentful.js) and [contentful-management.js](https://github.com/contentful/contentful-management.js) SDKs.
## About
[Contentful](https://www.contentful.com) 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](https://github.com/contentful/contentful.js) and [contentful-management.js](https://github.com/contentful/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
```