Developer Docs
API Reference
Collections
Shared Fields
Functions
Function: createSlugField()

web


web / lib/collections/shared-fields / createSlugField

Function: createSlugField()

createSlugField<T>(collection, sourceField): Field

Type Parameters

T

T extends "datasets" | "catalogs" | "dataset-schemas" | "import-files" | "import-jobs" | "events" | "users" | "media" | "location-cache" | "geocoding-providers" | "pages" | "payload-jobs" | "payload-locked-documents" | "payload-preferences" | "payload-migrations"

Parameters

collection

T

sourceField

string = "name"

Returns

Field