rsql-criteria-typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Main class for bringing together API filtering, sorting and pagination.

Hierarchy

  • RSQLCriteria

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RSQLCriteria(whereKeyword?: string, orderByKeyword?: string, pageSizeKeyword?: string, includeTotalCountKeyword?: string, pageNumberKeyword?: string): RSQLCriteria

  • Parameters

    • Default value whereKeyword: string = "$where"
    • Default value orderByKeyword: string = "$orderBy"
    • Default value pageSizeKeyword: string = "$pageSize"
    • Default value includeTotalCountKeyword: string = "$includeTotalCount"
    • Default value pageNumberKeyword: string = "$pageNumber"

    Returns RSQLCriteria

Properties

filters

filters: RSQLFilterList

includeTotalCount

includeTotalCount: boolean = true

Private includeTotalCountKeyword

includeTotalCountKeyword: string

orderBy

orderBy: RSQLOrderByList

Private orderByKeyword

orderByKeyword: string

Optional pageNumber

pageNumber: undefined | number

Private pageNumberKeyword

pageNumberKeyword: string

Optional pageSize

pageSize: undefined | number

Private pageSizeKeyword

pageSizeKeyword: string

Private whereKeyword

whereKeyword: string

Methods

and

  • Brings together the two criteria filters, ignoring the order by and pagination from the passed in criteria. Only keeps it from the original RSQLCriteria.

    Parameters

    Returns void

build

  • Builds the query string that will be needed to send down to the server side API. Combines the keywords with their appropriate clauses to create the string.

    Parameters

    Returns string

or

  • Brings together the two criteria filters, ignoring the order by and pagination from the passed in criteria. Only keeps it from the original RSQLCriteria.

    Parameters

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Private property
  • Private method

Generated using TypeDoc