Skip to content

Add "exclude" option as a supplement to "include" #1288

@evantrimboli

Description

@evantrimboli

I'm submitting a...


[ ] Regression 
[ ] Bug report
[x] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Currently, a swagger document gives you the option for which modules to include. This is very useful.

Expected behavior

It would be useful to provide the opposite of this, where a set of modules could be excluded.

Minimal reproduction of the problem with instructions

N/A

What is the motivation / use case for changing the behavior?

Let's say I'm developing an API that could be reasonably separated into two parts, client A will only call into section 1, client B will only call into section 2. If I want to generate an API document, I can do something like this:

const section1Modules = [foo, bar, baz];
const opts = {
  include: process.ENV.section1 ? section1Modules : undefined,
  exclude: process.ENV.section2 ? section1Modules: undefined
};

Without this, I would need to maintain two sets of modules, as opposed to just a single one here. Thanks for your consideration.

Environment


Nest version:4.7.16
 
For Tooling issues:
N/A

Others:
N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions