TypeScript Delivery SDK API Reference

import contentstack from '@contentstack/delivery-sdk';
import type { BaseEntry } from '@contentstack/delivery-sdk';

const stack = contentstack.stack({
  apiKey: '<API_KEY>',
  deliveryToken: '<DELIVERY_TOKEN>',
  environment: '<ENVIRONMENT>',
});

try {
  const result = await stack.contentType('<CONTENT_TYPE_UID>').entry('<ENTRY_UID>').fetch<BaseEntry>();
  console.log(result.title);
} catch (error: any) {
  // Thrown for API rejections and network failures
  console.error('Request failed:', error.status, error.error_code, error.error_message);
}

import contentstack, { QueryOperation } from '@contentstack/delivery-sdk';
import type { BaseEntry } from '@contentstack/delivery-sdk';

const stack = contentstack.stack({
  apiKey: '<API_KEY>',
  deliveryToken: '<DELIVERY_TOKEN>',
  environment: '<ENVIRONMENT>',
});

try {
  // query() opens the filter, then sort, page size, and count follow.
  const result = await stack
    .contentType('<CONTENT_TYPE_UID>')
    .entry()
    .query()
    .where('title', QueryOperation.EXISTS, true)
    .orderByDescending('updated_at')
    .limit(5)
    .includeCount()
    .find<BaseEntry>();
  console.log('showing', result.entries?.length, 'of', result.count);
  for (const entry of result.entries ?? []) {
    console.log(entry.uid, entry.title);
  }
} catch (error: any) {
  console.error(error);
}

import contentstack from '@contentstack/delivery-sdk';
import type { BaseEntry } from '@contentstack/delivery-sdk';

const stack = contentstack.stack({
  apiKey: '<API_KEY>',
  deliveryToken: '<DELIVERY_TOKEN>',
  environment: '<ENVIRONMENT>',
});

const pageSize = 25;
const all: BaseEntry[] = [];

try {
  let total = 0;
  do {
    // A fresh entry() per page, so each request carries its own skip value.
    const page = await stack
      .contentType('<CONTENT_TYPE_UID>')
      .entry()
      .skip(all.length)
      .limit(pageSize)
      .includeCount()
      .find<BaseEntry>();
    const entries = page.entries ?? [];
    all.push(...entries);
    total = page.count ?? 0;
    if (entries.length === 0) break;
  } while (all.length < total);
  console.log('read', all.length, 'of', total, 'entries');
} catch (error: any) {
  console.error(error);
}

import contentstack from '@contentstack/delivery-sdk';

const stack = contentstack.stack({
  apiKey: '<API_KEY>',
  deliveryToken: '<DELIVERY_TOKEN>',
  environment: '<ENVIRONMENT>',
});

try {
  // true follows every pagination token and returns all items at once.
  const initial = await stack.sync({}, true);
  console.log('published items:', initial.items.length);

  // Store sync_token, then pass it on the next run to receive only the changes.
  if (initial.sync_token) {
    const changes = await stack.sync({ syncToken: initial.sync_token });
    console.log('changed since the first sync:', changes.items.length);
  }
} catch (error: any) {
  console.error(error);
}

import contentstack from '@contentstack/delivery-sdk';
import type { BaseEntry } from '@contentstack/delivery-sdk';

const stack = contentstack.stack({
  apiKey: '<API_KEY>',
  deliveryToken: '<DELIVERY_TOKEN>',
  environment: '<ENVIRONMENT>',
});

try {
  const entry = await stack.contentType('<CONTENT_TYPE_UID>').entry('<ENTRY_UID>').fetch<BaseEntry>();
  console.log(entry.title);
} catch (error: any) {
  if (error.status === 0 && error.error_code === 'UNKNOWN_ERROR') {
    // A 401 or 429 that outlasted the retries: check the delivery token and the rate limit.
    console.error('Rejected after retries:', error.error_message);
  } else if (error.status === 0) {
    // No response arrived: error_code holds the Node.js code, or 408 for a timeout.
    console.error('Network failure:', error.error_code);
  } else {
    // The API answered and rejected the request, for example 422 for an unknown UID.
    console.error('API error:', error.status, error.error_code, error.error_message);
  }
}