Skip to main content

Languages Module

The languages module manages supported languages for multi-language content.

Configuration Options

The languages module has no configuration options.

Module API

Access via modules.languages in the Unchained API context.

Queries

MethodArgumentsDescription
findLanguage{ languageId? | isoCode? }Find language by ID or ISO code
findLanguages{ limit?, offset?, sort?, ...query }List languages with pagination
countqueryCount languages matching criteria
languageExists{ languageId }Check if language exists
isBaselanguageCheck if this is the default language

Mutations

MethodArgumentsDescription
createdocCreate a new language
updatelanguageId, docUpdate language
deletelanguageIdDelete language

Usage

// Find a language
const german = await modules.languages.findLanguage({ isoCode: 'de' });

// Check if it's the base language
const isDefault = modules.languages.isBase(german);

// List all active languages
const languages = await modules.languages.findLanguages({
includeInactive: false,
});

Events

EventPayloadDescription
LANGUAGE_CREATE{ languageId }Emitted when a language is created
LANGUAGE_UPDATE{ languageId }Emitted when a language is updated
LANGUAGE_REMOVE{ languageId }Emitted when a language is removed