Skip to content

docs: mention ContextBuilder returned from #check()#972

Open
fedeci wants to merge 1 commit intoexpress-validator:masterfrom
fedeci:get-builder-properties
Open

docs: mention ContextBuilder returned from #check()#972
fedeci wants to merge 1 commit intoexpress-validator:masterfrom
fedeci:get-builder-properties

Conversation

@fedeci
Copy link
Member

@fedeci fedeci commented Jan 2, 2021 •
edited
Loading

Description

We mention in the docs that ContextBuilder is exposed in the result of #check() middleware.

This allows to get the properties of the builder.
It can be used to create a library based on the context that will be built.
(e.g. swagger docs generation)

I don't know if it is better to expose the properties in this way or to build a "local" context, @gustavohenke what do you think?

To-do list

  • I have added tests for what I changed.
  • This pull request is ready to merge.

@coveralls
Copy link

coveralls commented Jan 2, 2021 •
edited
Loading

Coverage Status

Coverage remained the same at 100.0% when pulling 939bae6 on fedeci:get-builder-properties into 690cd63 on express-validator:master.

@fedeci fedeci requested a review from gustavohenke January 2, 2021 23:08
gustavohenke
gustavohenke reviewed Jan 11, 2021
View reviewed changes
Copy link
Member

@gustavohenke gustavohenke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if it is better to expose the properties in this way or to build a "local" context

Hmm I don't mind either way at the moment. The Context interface is quite small, so this looks reasonable for now.

I don't recall if the .builder property is exposed/documented anywhere... do you think it would make more sense to put it in

express-validator/src/chain/context-handler.ts

Lines 5 to 9 in 7f15d2d

export interface ContextHandler<Chain> {
bail(): Chain;
if(condition: CustomValidator | ValidationChain): Chain;
optional(options?: Partial<Optional> | true): Chain;
}
instead?

@fedeci
Copy link
Member Author

fedeci commented Jan 13, 2021 •
edited
Loading

Yes, for example in check it is exposed here.
Maybe we should just document this so that the end user could create his own context with all his methods and not only access properties through the builder.

express-validator/src/middlewares/check.ts

Lines 32 to 40 in 7f15d2d

return Object.assign(
middleware,
bindAll(runner),
bindAll(new SanitizersImpl(builder, middleware as any)),
bindAll(new ValidatorsImpl(builder, middleware as any)),
bindAll(new ContextHandlerImpl(builder, middleware as any)),
{ builder },
);
}

@fedeci fedeci force-pushed the get-builder-properties branch from 741b357 to d4250a2 Compare February 23, 2021 20:12
@fedeci fedeci added the docs label Feb 23, 2021
@fedeci fedeci changed the title feat(context-builder): add 'getProperties' method docs: mention ContextBuilder returned from #check() Feb 23, 2021
@fedeci fedeci requested a review from gustavohenke February 23, 2021 20:15
gustavohenke
gustavohenke requested changes Mar 15, 2021
View reviewed changes
Copy link
Member

@gustavohenke gustavohenke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will LGTM if we can add more docs than just this 😬

  • API entry
  • Possibly an entry under "Features", if it's necessary to showcase more of it

@fedeci fedeci requested a review from gustavohenke July 27, 2021 20:27
@fedeci fedeci force-pushed the get-builder-properties branch from d4250a2 to 939bae6 Compare July 29, 2021 09:56
gustavohenke
gustavohenke reviewed Aug 8, 2021
View reviewed changes
Copy link
Member

@gustavohenke gustavohenke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...did you want to address the previous review?

@fedeci
Copy link
Member Author

fedeci commented Aug 8, 2021

Oops nope, asked review for the wrong PR😄

@gustavohenke gustavohenke force-pushed the master branch 2 times, most recently from 3177f64 to 6e160b1 Compare April 7, 2023 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gustavohenke gustavohenke gustavohenke requested changes

Assignees

No one assigned

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@fedeci @coveralls @gustavohenke