Skip to content

Improve type definition for Filter #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fflorent wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve type definition for Filter #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/lib/types/filter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ const isoDate = /^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12

/**
* SCIM Filter Type
* @template {SCIMMY.Types.Schema} [S=*] - The object the filter applies on
* @alias SCIMMY.Types.Filter
* @summary
* * Parses SCIM [filter expressions](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2) into object representations of the filter expression.
Expand Down Expand Up @@ -278,8 +279,8 @@ export class Filter extends Array {

/**
* Compare and filter a given set of values against this filter instance
* @param {Object[]} values - values to evaluate filters against
* @returns {Object[]} subset of values that match any expressions of this filter instance
* @param {S[]} values - values to evaluate filters against
* @returns {S[]} subset of values that match any expressions of this filter instance
*/
match(values) {
// Match against any of the filters in the set
Expand Down
4 changes: 2 additions & 2 deletions src/lib/types/resource.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,8 @@ export class Resource {
* @param {Number} [config.startIndex] - offset index that retrieved resources should start from
* @param {Number} [config.count] - maximum number of retrieved resources that should be returned in one operation
* @property {String} [id] - ID of the resource instance being targeted
* @property {SCIMMY.Types.Filter} [filter] - filter parsed from the supplied config
* @property {SCIMMY.Types.Filter} [attributes] - attributes or excluded attributes parsed from the supplied config
* @property {SCIMMY.Types.Filter<S>} [filter] - filter parsed from the supplied config
* @property {SCIMMY.Types.Filter<S>} [attributes] - attributes or excluded attributes parsed from the supplied config
* @property {SCIMMY.Messages.ListResponse~ListConstraints} [constraints] - sort and pagination properties parsed from the supplied config
* @property {String} [constraints.sortBy] - the attribute retrieved resources should be sorted by
* @property {String} [constraints.sortOrder] - the direction retrieved resources should be sorted in
Expand Down