API Reference & Compatibility

The complete public API symbol inventory is generated automatically from package source exports:

Functions

formatJalaliDate

Source

formatJalaliDate(value: JalaliDateValue, options?: JalaliDateDisplayOptions) => string | null

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

formatMoney

Source

formatMoney(value: number | null | undefined, currency: MoneyCurrency, display?: MoneyDisplayOptions) => string | null

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

formatSlug

Source

formatSlug(value: string) => string

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

jalaliDateField

Source

jalaliDateField(options: JalaliDateFieldOptions) => DateField

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

moneyField

Source

moneyField(options: MoneyFieldOptions) => NumberField

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

parseMoneyToMinorUnits

Source

parseMoneyToMinorUnits(input: string, currency: MoneyCurrency) => number

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

payloadFieldsPlugin

Source

payloadFieldsPlugin(options?: PayloadFieldsPluginOptions) => Plugin

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

resolveCurrency

Source

resolveCurrency(currency: MoneyCurrency) => MoneyCurrencyDefinition

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

slugField

Source

slugField(options?: SlugFieldOptions) => SlugFieldResult

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

withJalaliTimestamps

Source

withJalaliTimestamps<T extends Field[]>(fields: T, options?: JalaliTimestampsOptions) => Field[]

Exported from: @nexload-sdk/payload-fields

Public function exported by @nexload-sdk/payload-fields.

Constants

IRR

Source

IRR: Readonly<MoneyCurrencyDefinition>

Exported from: @nexload-sdk/payload-fields

Public constant exported by @nexload-sdk/payload-fields.

IRT

Source

IRT: Readonly<MoneyCurrencyDefinition>

Exported from: @nexload-sdk/payload-fields

Public constant exported by @nexload-sdk/payload-fields.

formatSlugHook

Source

formatSlugHook(options: SlugHookOptions) => FieldHook

Exported from: @nexload-sdk/payload-fields

Public constant exported by @nexload-sdk/payload-fields.

Types

JalaliDateDisplayOptions

Source

type JalaliDateDisplayOptions = {
  dateStyle?: "short" | "medium" | "long" | "full"
  timeStyle?: "short" | "medium"
  digits?: "persian" | "latin"
  timeZone?: string
};

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

JalaliDateFieldOptions

Source

type JalaliDateFieldOptions = {
  name: string
  pickerAppearance?: JalaliPickerAppearance
  display?: import("./format-date").JalaliDateDisplayOptions
  overrides?: Partial<DateField>
};

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

JalaliDateValue

Source

type JalaliDateValue = Date | string | number | null | undefined;

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

JalaliPickerAppearance

Source

type JalaliPickerAppearance
  = | "dayOnly"
    | "dayAndTime"
    | "timeOnly"
    | "monthOnly";

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

JalaliTimestampsOptions

Source

type JalaliTimestampsOptions = {
  createdAt?: boolean
  updatedAt?: boolean
  display?: import("./format-date").JalaliDateDisplayOptions
  overrides?: { createdAt?: Partial<TextField>, updatedAt?: Partial<TextField> }
};

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

MoneyCurrency

Source

type MoneyCurrency = "IRR" | "IRT" | MoneyCurrencyDefinition;

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

MoneyCurrencyDefinition

Source

type MoneyCurrencyDefinition = {
  code: string
  label: string
  fractionDigits: number
};

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

MoneyDisplayOptions

Source

type MoneyDisplayOptions = {
  locale?: string
  digits?: "persian" | "latin"
  grouping?: boolean
  showCurrency?: boolean
};

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

MoneyFieldOptions

Source

type MoneyFieldOptions = {
  name: string
  currency: MoneyCurrency
  minMinorUnits?: number
  maxMinorUnits?: number
  allowNegative?: boolean
  display?: MoneyDisplayOptions
  overrides?: Partial<NumberField>
};

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

PayloadFieldsPluginOptions

Source

type PayloadFieldsPluginOptions = { slugGenerators?: Record<string, SlugGenerator>, generateSlugAccess?: SlugGenerationAccess };

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

SlugFieldOptions

Source

type SlugFieldOptions = {
  name?: string
  lockName?: string
  source?: string
  generator?: string
  regenerateOnSourceChange?: boolean
  overrides?: { slug?: Partial<TextField>, lock?: Partial<CheckboxField> }
};

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

SlugFieldResult

Source

type SlugFieldResult = readonly [TextField, CheckboxField];

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

SlugGenerationAccess

Source

type SlugGenerationAccess = (context: SlugGeneratorContext) => boolean | Promise<boolean>;

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

SlugGenerator

Source

type SlugGenerator = (input: SlugGeneratorInput, context: SlugGeneratorContext) => Promise<string>;

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

SlugGeneratorContext

Source

type SlugGeneratorContext = { req: PayloadRequest };

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

SlugGeneratorInput

Source

type SlugGeneratorInput = { sourceValue: string, currentSlug?: string };

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

SlugHookOptions

Source

type SlugHookOptions = {
  name: string
  lockName: string
  source: string
  regenerateOnSourceChange: boolean
};

Exported from: @nexload-sdk/payload-fields

Public type exported by @nexload-sdk/payload-fields.

---

Exported Factories Summary

Function	Output	Description
slugField(options)	[Field, Field]	Returns [slug, slugLock] fields configured with Unicode slugifier and sync logic.
jalaliDateField(options)	DateField	Returns a Payload date field configured with the Jalali solar calendar Admin component.
moneyField(options)	NumberField	Returns an integer number field configured with formatted currency Admin component.
payloadFieldsPlugin(options)	Plugin	Registers custom server-side slug generator REST endpoints.

---

Runtime Compatibility Matrix

Runtime / Engine	Version Requirement	Verification Status
Node.js	>=20.9.0	Verified on Node 20 & 22
Payload CMS	>=3.85.0 <4.0.0	Verified on Payload 3.86.0
React / React-DOM	^19.0.0	Required for Payload 3 Admin UI
Module Format	ESM only	Server and Admin Import Map safe
Side Effects	false	Fully tree-shakeable