\n\n { | \n
\n\n \"fields\": | \n \n \n An array of source fields to use for generating the slug. The value of multiple fields is concatenated using the config.separator property. This is the only required option.\n \n | \n
\n\n \"strategy\": | \n \n \n The strategy to use for keeping slugs unique. It can be one of the pre-existing strategy names (\"dbIncrement\" or \"shortId\") or a factory function that returns a custom strategy implementation. Defaults to no uniqueness handling.\n \n | \n
\n\n \"allowUpdates\": | \n \n \n A boolean to enable updates, or a function that receives the model instance and returns a boolean. Updates are disabled by default.\n \n | \n
\n\n \"maxLength\": | \n \n \n The maximum length for the generated slug. The final slug value can be slightly over the defined maxLength in the following scenarios.\n \n \n No max length is applied by default.\n \n \n - \n When
completeWords is set to true.\n \n - \n When using the
dbIncrement strategy. The counter value is appended after trimming the value for the maxLength.\n \n \n | \n
\n\n \"completeWords\": | \n \n \n A boolean that forces to complete the words when applying the maxLength property. Completing words will generate a slug larger than the maxLength. So, keep some buffer between the maxLength property and the database storage size.\n \n \n Complete words are disabled by default.\n \n | \n
\n\n \"separator\": | \n \n \n The separator to use for creating the slug. A dash - is used by default.\n \n | \n
\n\n \"transformer\": | \n \n \n A custom function to convert non-string source values to a string before they are slugified. It receives the model instance, the field name, and the field value, and must return a string.\n \n \n By default, booleans are converted to \"1\" or \"0\", Date values are converted using date.toJSON(), and everything else is converted using String(value).\n \n | \n
\n\n } | \n
\n
\n\n### Generating slugs from multiple fields\n\nWhen you specify more than one field, their values are concatenated using the `separator` (in the order they are defined) and the result is slugified.\n\n```ts\n@slugify({\n fields: ['seriesName', 'title'],\n separator: '-',\n})\ndeclare slug: string\n```\n\n### Customizing the transformer\n\nThe `transformer` is handy when a source field holds a rich data type that should not be stringified using the default rules.\n\n```ts\n@slugify({\n fields: ['title', 'publishedAt'],\n transformer: (post, field, value) => {\n if (field === 'publishedAt' && value instanceof DateTime) {\n return value.toFormat('yyyy-MM-dd')\n }\n\n return String(value)\n },\n})\ndeclare slug: string\n```\n\n## Using custom strategies\n\nCustom strategies can be used if you want to handle the uniqueness of slugs yourself. A strategy must implement the [`SlugifyStrategyContract`](#slugifystrategycontract) interface.\n\n```ts\nimport { LucidRow } from '@adonisjs/lucid/types/model'\nimport { SlugifyStrategyContract } from '@adonisjs/lucid-slugify/types'\n\nexport class MyCustomStrategy implements SlugifyStrategyContract {\n maxLengthBuffer: number = 0\n\n async makeSlugUnique(modelInstance: LucidRow, field: string, value: string) {\n return value\n }\n}\n```\n\nThe `makeSlugUnique` method receives the following arguments.\n\n- `modelInstance`: Reference to the model instance that will be persisted in the database.\n- `field`: The name of the field for which the unique slug will be created.\n- `value`: The base value to convert to a unique value.\n\nOnce you have created the strategy, you can use it with the `@slugify` decorator by registering it as a factory function. The factory receives the model class, the property name, and the resolved decorator config, allowing you to build the strategy with the same configuration.\n\n```ts\nexport default class Post extends PostSchema {\n @slugify({\n strategy: (model, propertyName, config) => {\n return new MyCustomStrategy()\n },\n fields: ['title'],\n })\n declare slug: string\n}\n```\n\nThe built-in strategy classes are also exported, so you can reuse or extend them from a factory function.\n\n```ts\nimport { DbIncrementStrategy, ShortIdStrategy } from '@adonisjs/lucid-slugify/strategies'\n```\n\n## Self creating slugs\n\nThe default implementation used by Lucid slugify for creating slugs works great with English words. However, if you are using Non-Latin alphabets, replace the implementation for creating slugs with a custom one.\n\nYou can override the static `slugify` method on the `Slugifier` class. The following code has to be executed only once (for example, inside a service provider).\n\n```ts\nimport { Slugifier } from '@adonisjs/lucid-slugify'\n\n/**\n * Make sure to install the \"transliteration\" package\n */\nimport { slugify } from 'transliteration'\n\nSlugifier.slugify = function (value, options) {\n return slugify(value, {\n separator: options.separator,\n lowercase: options.lower,\n })\n}\n```\n\n## API reference\n\n### Entry points\n\n| Import path | Exports |\n| ------------------------------------ | -------------------------------------------------------------------------------------------- |\n| `@adonisjs/lucid-slugify` | [`slugify`](#slugify-config) decorator, [`Slugifier`](#slugifier) class, [`errors`](#errors) |\n| `@adonisjs/lucid-slugify/strategies` | `DbIncrementStrategy`, `ShortIdStrategy` |\n| `@adonisjs/lucid-slugify/types` | `SlugifyConfig`, `SlugifierConfig`, [`SlugifyStrategyContract`](#slugifystrategycontract) |\n\n### slugify(config)\n\nA property decorator that marks a Lucid model column as a slug. It registers `beforeCreate` and `beforeUpdate` hooks on the model to compute and persist the slug.\n\n```ts\nimport { slugify } from '@adonisjs/lucid-slugify'\n\n@slugify({ fields: ['title'], strategy: 'dbIncrement' })\ndeclare slug: string\n```\n\nSee [Available options](#available-options) for the complete list of accepted config properties.\n\n### Slugifier\n\nThe class that powers slug generation. You usually do not interact with it directly — the `@slugify` decorator creates and manages a `Slugifier` instance per slug field for you.\n\nThe one member relevant to end-users is the static `slugify` method, which converts a string into a URL-safe slug. Override it to plug in a custom slugification routine (see [Self creating slugs](#self-creating-slugs)).\n\n```ts\nSlugifier.slugify(value: string, options: { separator: string; lower: boolean }): string\n```\n\n### SlugifyStrategyContract\n\nThe interface that every strategy (built-in or custom) implements.\n\n```ts\ninterface SlugifyStrategyContract {\n /**\n * The number of characters the strategy may add to the slug to make it\n * unique. The slugifier reserves this many characters when applying the\n * `maxLength` option, so the final value stays within the column size.\n */\n maxLengthBuffer: number\n\n /**\n * Convert the computed slug value into a unique value that is safe to\n * persist to the database.\n */\n makeSlugUnique(modelInstance: LucidRow, field: string, value: string): Promise