Child Decorators

Introduction

To make configurations more concise, awe-axios also provides child decorators specifically for mock functionality. You can use @Mock to configure mock-related settings. This decorator accepts two parameters:

1. The first parameter is handlers. It can be either a handler function or an object.

// Using a single handler function
@Mock(async ({ request, params }) => {
  return HttpResponse.json({
    data: [
      { id: 1, name: 'Alice' },
      { id: 2, name: 'Bob' },
    ],
  });
})

// Or using a handlers object
@Mock({
  default: async ({ request, params }) => {
    return HttpResponse.json({
      data: [
        { id: 1, name: 'Alice' },
        { id: 2, name: 'Bob' },
      ],
    });
  },
  success: async ({ request, params }) => {
    return HttpResponse.json({
      data: [
        { id: 1, name: 'Alice' },
        { id: 2, name: 'Bob' },
      ],
    });
  },
})

2. The second parameter is the mock configuration object (MockConfig).

export type MockConfig = {
  /**
   * Whether to enable mock
   * @description If enabled and conditions are met, all requests will go through the mock interface
   */
  on?: boolean;
  /**
   * Condition for using mock
   * @description After enabling mock, to avoid changing the original code, we can set conditions for using the real interface
   */
  condition?: () => boolean;
  /**
   * Operation count
   * @description The number of times the mock will be used. After the interface has been mocked for the specified count, it will no longer access the mock interface.
   */
  count?: number;

  /**
   * Signal to cancel mock
   * @description Unlike `condition`, this can dynamically cancel the mock
   */
  signal?: Signal;
};

Priority and Merge Strategy

The handlers defined in @Mock will be merged with the handlers defined in HTTP decorators like @Get. The priority of the @Mock decorator's handlers is lower than that of the HTTP decorators (@Get, @Post, etc.). This means that if the same handlers are defined in both @Mock and @Get, the handlers from the HTTP decorator (@Get) will take effect, and the handlers from the @Mock decorator will be ignored.