API Reference

Complete reference for the TridentClient API.

createTridentClient

Factory function to create a new Trident client instance.

function createTridentClient(config: TridentClientConfig): TridentClient

TridentClientConfig

client.getArticles()

Fetch a paginated list of published articles.

async getArticles(options?: GetArticlesOptions): Promise<{
  data: Article[];
  pagination: Pagination;
}>

Options

client.getAllArticles()

Fetch all published articles across pages.

async getAllArticles(options?: GetAllArticlesOptions): Promise<Article[]>

Options

client.getArticle()

Fetch a single article by its slug.

async getArticle(
  slug: string,
  options?: GetArticleOptions
): Promise<Article>

Throws

• TridentNotFoundError if article doesn't exist
• TridentAuthError if API key is invalid

client.getSitemap()

Fetch all sitemap entries for generating sitemap.xml.

async getSitemap(): Promise<SitemapEntry[]>

SitemapEntry

interface SitemapEntry {
  slug: string;
  productSlug: string;
  languageCode: string;
  territoryCode: string;
  publishedAt: string | null;
  updatedAt: string;
}

client.getLastRequestId()

Read the last request ID returned by the API (if available).

getLastRequestId(): string | null

Error Classes

All errors extend TridentError and include error codes and HTTP status codes.

Error Handling Example

import {
  TridentNotFoundError,
  TridentRateLimitError,
} from "@trident/client";

try {
  const article = await client.getArticle(slug);
} catch (error) {
  if (error instanceof TridentNotFoundError) {
    // Article doesn't exist
    notFound();
  }
  if (error instanceof TridentRateLimitError) {
    // Wait and retry
    console.log(`Retry after: ${error.retryAfter}s`);
  }
  throw error;
}