# egg-serializer

**Repository Path**: mirrors_eggjs/egg-serializer

## Basic Information

- **Project Name**: egg-serializer
- **Description**: serializer any data to response
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# egg-serializer

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-serializer.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-serializer
[travis-image]: https://img.shields.io/travis/eggjs/egg-serializer.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-serializer
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-serializer.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-serializer?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-serializer.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-serializer
[snyk-image]: https://snyk.io/test/npm/egg-serializer/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-serializer
[download-image]: https://img.shields.io/npm/dm/egg-serializer.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-serializer

serializer any data to response

## Install

```bash
$ npm i egg-serializer --save
```

## Usage

```js
// {app_root}/config/plugin.js
exports.serializer = {
  enable: true,
  package: 'egg-serializer',
};
```

## Example

### `ctx.serialize` in Controller

```js
ctx.body = ctx.serialize('api.user', user);

// with options
ctx.body = ctx.serialize('api.search', searchResult, { foo: 'bar' });
```

### Serializers

### Easy way, exports fields

```js
module.exports = [
  'name',
  'age',
];
```

#### Simple way, only provider fields

```js
// {app_root}/app/serializer/user.js
module.exports = app => {
  return class extends app.Serializer {
    get fields() {
      return [
        'name',
        'age',
        // ... and so on
      ];
    }
  }
};
```

#### Custom way, override format method

```js
// {app_root}/app/serializer/api/search.js
module.exports = app => {
  return class extends app.Serializer {
    constructor() {
      super();
      this.fields = [
        'count',
        'time',
        // ... and so on
      ];
    }

    format(obj, options) {
      const data = this.pick(obj);

      data.book = app.serialize('api.book', obj.book);
      data.user = app.serialize('api.user', obj.user);
      data.last_editor = app.serialize('api.user', obj.last_editor);
      data.server_time = Date.now();
      if (options.foo === 'bar') {
        data.foo = 'bar';
      }

      return data;
    },
  }
};
```

## Configuration

```js
// {app_root}/config/config.default.js
exports.serializer = {
  // show `_serializer` property on data
  showSerializerType: false,
};
```

see [config/config.default.js](config/config.default.js) for more detail.

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](LICENSE)