The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
The current Contentful.js version
A client that will fetch assets and entries with all locales. Only available if not already enabled.
A client that will not resolve links in entries. Only available if not already disabled.
A client that will remove unresolvable links from entries. Only available if not already disabled.
Creates an asset key for signing asset URLs (Embargoed Assets)
import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const assetKey = await client.getAssetKey(<UNIX timestamp>)
console.log(assetKey)
Promise for an asset key
Fetches an asset
const contentful = require('contentful')
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const asset = await client.getAsset('<asset_id>')
console.log(asset)
If provided for a client using allLocales modifier, response type defines locale keys for asset field values.
Optional query: AssetQueries<Modifiers>Object with search parameters. In this method it's only useful for locale.
Promise for an asset
Fetches a collection of assets
const contentful = require('contentful')
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const response = await client.getAssets()
console.log(response.items)
If provided for a client using allLocales modifier, response type defines locale keys for asset field values.
Optional query: AssetsQueries<AssetFields, Modifiers>Object with search parameters
Promise for a collection of Assets
Fetches a content type
import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const contentType = await client.getContentType('<content_type_id>')
console.log(contentType)
The content type’s ID
Promise for a content type
Fetches a collection of content types
import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const response = await client.getContentTypes()
console.log(response.items)
Optional query: { Optional query?: stringPromise for a collection of content types
Fetches a collection of Entries
const contentful = require('contentful')
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const response = await client.getEntries()
console.log(response.items)
Shape of entry fields used to calculate dynamic keys
If provided for a client using allLocales modifier, response type defines locale keys for entry field values.
Optional query: EntriesQueries<EntrySkeleton, Modifiers>Object with search parameters
Promise for a collection of Entries
Fetches an entry
const contentful = require('contentful')
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const entry = await client.getEntry('<entry_id>')
console.log(entry)
Shape of entry fields used to calculate dynamic keys
If provided for a client using allLocales modifier, response type defines locale keys for entry field values.
The entry’s ID
Optional query: EntryQueries<Modifiers>Object with search parameters. In this method it's only used for locale when querying.
Promise for an entry
Fetches a collection of locales
import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const response = await client.getLocales()
console.log(response.items)
Promise for a collection of locales
Fetches the space which the client is currently configured to use
import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const space = await client.getSpace()
console.log(space)
Promise for the space
Fetches a tag
import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const tag = await client.getTag('<asset_id>')
console.log(tag)
The tag’s ID
Promise for a tag
Gets a collection of Tags
import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const response = await client.getTags()
console.log(response.items)
Optional query: TagQueriesPromise for a collection of tags
Parse raw json data into a collection of entries. objects.Links will be resolved also
const data = {items: [
{
sys: {type: 'Entry', locale: 'en-US'},
fields: {
animal: {sys: {type: 'Link', linkType: 'Animal', id: 'oink'}},
anotheranimal: {sys: {type: 'Link', linkType: 'Animal', id: 'middle-parrot'}}
}
}
],
includes: {
Animal: [
{
sys: {type: 'Animal', id: 'oink', locale: 'en-US'},
fields: {
name: 'Pig',
friend: {sys: {type: 'Link', linkType: 'Animal', id: 'groundhog'}}
}
}
]
}
}
console.log( data.items[0].fields.foo ); // undefined
const parsedData = client.parseEntries(data);
console.log( parsedData.items[0].fields.foo ); // foo
Shape of entry fields used to calculate dynamic keys
If provided for a client using allLocales modifier, response type defines locale keys for entry field values.
json data
Synchronizes either all the content or only new content since last sync. Important note: The Sync API endpoint does not support include or link resolution. However, contentful.js can do link resolution on the client side for the initial sync. For the delta sync (using nextSyncToken) link resolution is not possible since the sdk won’t have access to all linked entities.
import * as contentful from 'contentful'
const client = contentful.createClient({
space: '<space_id>',
accessToken: '<content_delivery_api_key>'
})
const response = await client.sync({
initial: true
})
console.log({
entries: response.entries,
assets: response.assets,
nextSyncToken: response.nextSyncToken
})
Shape of entity fields used to calculate dynamic keys
The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
If provided for a client using allLocales modifier, response type defines locale keys for entity field values.
Query object
Optional syncOptions: SyncOptions
Contentful Delivery API Client. Contains methods which allow access to the different kinds of entities present in Contentful (Entries, Assets, etc).