https://github.com/thinkjs/think-mock

Mock for Thinkjs
https://github.com/thinkjs/think-mock

Last synced: about 1 month ago
JSON representation

Mock for Thinkjs

• Host: GitHub
• URL: https://github.com/thinkjs/think-mock
• Owner: thinkjs
• License: mit
• Created: 2017-04-17T06:57:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T17:27:47.000Z (about 2 years ago)
• Last Synced: 2024-10-13T02:08:14.877Z (2 months ago)
• Language: JavaScript
• Size: 1010 KB
• Stars: 0
• Watchers: 13
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• think-awesome - think-mock

README

        
# think-mock

Mock data for ThinkJS3.

## Precondition

think-mock need Babel support! For:

  - @babel/plugin-proposal-class-properties

  - @babel/plugin-proposal-decorators

  

is used!Replace them with corresponding plugin if babel6 is used in your project!

1. Open Babel transform (Both development or production enviroment)

2. Add plugin to babel config

## How to Use

1. Add extend support 

```js

// think.ROOT_PATH/src/config/extend.js 

const mock = require('think-mock');

module.exports = [

  mock(think.app),

];

```

2. Config mock path, or use default

```js

  // config.js

  mock: path.join(think.ROOT_PATH, 'mock'), // default

```

3. Create mock file

```js

  // think.ROOT_PATH/mock/user/index.js

  module.exports = {

    mock: 'This is mock data.'

  }

```

4. Add mock to action or method

```js

// controller/user.js

const { mock } = think.Controller.prototype;

module.exports = class extends think.Controller {

  @mock

  indexAction() {

    // mockFile think.ROOT_PATH/mock/user/index.js

    return this.json({ data: 'This is real data.' });

  }

  @mock getUserInfo() {

    // mockFile think.ROOT_PATH/mock/user/getUserInfo.js

  }

}

// service/sms.js

const { mock } = think.Service.prototype;

module.exports = class extends think.Service {

  @mock

  sendMessage() {

    // mockFile think.ROOT_PATH/mock/service/sms/sendMessage.js

    return { data: 'This is real data.' };

  }

};

```

## Production

Mock auto close when you are not at devlepment enviroment. 

You don't need remove decorator `mock`, but is better if you do.