web / lib/utils/slug / createSlugHook
Function: createSlugHook()
createSlugHook<
T>(collection,options?): (__namedParameters) =>Promise<undefined|string>
Hook function to be used in Payload collection field hooks
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
The collection name
options?
Optional object with sourceField (dot notation)
sourceField?
string
Returns
(
__namedParameters):Promise<undefined|string>
Parameters
__namedParameters
value?
string
data?
Record<string, unknown>
req?
PayloadRequest
operation?
string
originalDoc?
Record<string, unknown>
Returns
Promise<undefined | string>