# sequelize-sluggify

> Add slugs to Sequelize models

Latest version **1.0.4** (published 2017-08-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install sequelize-sluggify
pnpm add sequelize-sluggify
yarn add sequelize-sluggify
bun add sequelize-sluggify
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2017-08-26 |
| First published | 2017-08-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ruben Rutten |
| Maintainers | cyberuben |
| Keywords | slug, slugify, sluggify, sequelize, sequelize-plugin, orm |

## Links

- npm: https://www.npmjs.com/package/sequelize-sluggify
- Repository: https://github.com/Cyberuben/sequelize-sluggify
- Homepage: https://github.com/Cyberuben/sequelize-sluggify#readme
- Issues: https://github.com/Cyberuben/sequelize-sluggify/issues
- npm.io page: https://npm.io/package/sequelize-sluggify

## Dependencies (1)

- [slug](https://npm.io/package/slug.md) ^0.9.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2017-08-26
- 1.0.3 — 2017-08-26
- 1.0.2 — 2017-08-26
- 1.0.1 — 2017-08-26
- 1.0.0 — 2017-08-26

## README

# sequelize-sluggify

## Important

This is a fork from [Jarrod Connolly's sequelize-slugify](https://github.com/jarrodconnolly/sequelize-slugify) module. To be able to work with Sequelize version 4, I have rewritten most of it's code. Almost all text below is written by Jarrod Connolly and this version has been rewritten with almost the same API (sluggify seems to be a more used term than slugify), so that it can be used without having to change all code related to slugs.

--------------------

sequelize-sluggify is a model plugin for Sequelize that automatically creates and updates unique slugs for your models.

So far this module has only been tested with the PostgreSQL database.

## Installation

`npm install sequelize-sluggify`

## Requirements

You must place a slug field on your model something like this.

```javascript
slug: {
    type: DataTypes.STRING,
    unique: true
}
```

## Options

sluggifyModel takes an options object as it's second parameter.

```javascript
SequelizeSluggify.sluggifyModel(User, {
    source: ['givenName'],
    slugOptions: { lower: true },
    overwrite: false,
    column: 'slug'
});

```
Available Options

- `source` - (Required) Array of field names in the model to build the slug from.
- `suffixSource` - (Optional) Array of field names in the model to use as the source for additional suffixes to make the slug unique (before defaulting to adding numbers to the end of the slug).
- `slugOptions` - (Default `{lower: true}`) Pass additional options for slug generation as defined by [`slug`](https://github.com/dodo/node-slug).
- `overwrite` - (Default `TRUE`) Change the slug if the source fields change once the slug has already been built.
- `column` - (Default `slug`) Specify which column the slug is to be stored into in the model.
- `reservedSlugs` - (Default `[]`) Specify which slugs should be considered as 'reserved' and will therefor be skipped.

## Usage Examples

### Basic Usage

```javascript

var SequelizeSluggify = require('sequelize-sluggify');

module.exports = function(sequelize, DataTypes) {
    var User = sequelize.define('User', {
            slug: {
                type: DataTypes.STRING,
                unique: true
            },
            emailAddress: {
                type: DataTypes.STRING,
                allowNull: false,
                unique: true
            },
            givenName: {
                type: DataTypes.STRING,
                allowNull: false
            },
            familyName: {
                type: DataTypes.STRING,
                allowNull: false
            }
        });

    SequelizeSluggify.sluggifyModel(User, {
        source: ['givenName', 'familyName']
    });

    return User;
};

```

### Suffix Sources

```javascript

var SequelizeSluggify = require('sequelize-sluggify');

module.exports = function(sequelize, DataTypes) {
    var Movie = sequelize.define('Movie', {
            slug: {
                type: DataTypes.STRING,
                unique: true
            },
            title: {
                type: DataTypes.STRING,
                allowNull: false,
                unique: true
            },
            year: {
                type: DataTypes.INTEGER,
                allowNull: false
            }
        });

    SequelizeSluggify.sluggifyModel(Movie, {
        source: ['title'],
        suffixSource: ['year']
    });

    return Movie;
};

```

---
_Source: https://npm.io/package/sequelize-sluggify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._