Skip to main content
Version: v3

PaginationParamFilter

This is a convenience class for the filter param which works some magic, adds defaults and converts to the required PaginationParam format.

for example

  • filter=???

including fields this could be

  • filter=a=b

See description for PaginationParam for how multiple of these can be combined together to AND or OR together

For more information regarding the API see https://github.com/rancher/steve?tab=readme-ov-file#filter

Extends​

  • PaginationParam

Constructors​

Constructor​

new PaginationParamFilter(__namedParameters): PaginationParamFilter;

Parameters​

__namedParameters​
equals?​

boolean = true

should param equal fields

For definition see PaginationParam equals

fields?​

PaginationFilterField[] = []

Collection of fields to filter by.

Fields are ORd together

For definition see PaginationParam fields

Returns​

PaginationParamFilter

Overrides​

PaginationParam.constructor

Properties​

equals​

equals: boolean;

should fields equal param.

For example projectsornamexspaces=x or projectsornamexspaces!=x

Inherited from​

PaginationParam.equals

fields​

fields: PaginationFilterField[];

Fields to filter by

For example metadata.namespace=abc OR metadata.namespace=xyz

Inherited from​

PaginationParam.fields

param​

param: string;

Query Param. For example filter or projectsornamespaces

Inherited from​

PaginationParam.param

Methods​

createMultipleFields()​

static createMultipleFields(fields): PaginationParam;

Convenience method when you just want an instance of PaginationParamFilter with a simple filter=a=1,b=2,c=3 PaginationParam

These will be OR'd together

Parameters​

fields​

PaginationFilterField[]

Returns​

PaginationParam

createSingleField()​

static createSingleField(field): PaginationParam;

Convenience method when you just want an instance of PaginationParamFilter with a simple filter=x=y param

Parameters​

field​

FilterFieldCtorArgs

Returns​

PaginationParam