search string side menu

Search object for process instances

Type parameters

  • F: ApplicationFilterClosure<T>

Hierarchy

Methods

all

  • The method returns a search results page with the number of results equal to Search.size, beginning with Search.from.

    By default, the number of search results is 10. If you need more items, use the Search.size method. 

    const searchResults = await  Application.search()
    .where((f, g) => g.and ( 
        f.__deletedAt. eq(null), 
        f.service.link(Context.data.service) 
    )) 
    .all();

    Returns Promise<ProcessInstanceItem[]>

count

  • count(): Promise<number>

  • The method allows you to get the number of results in the search (it ignores Search.from and Search.size). 

    const searchResults = await Application.search()
   .where(( f, g) => g.and ( 
       f.__deletedAt.eq(null), 
       f.service. link(Context.data.service) 
   )) 
   .count();

    Returns Promise<number>

first

  • The method returns the first item among the search results. 

    const searchResults = await Application.search()
   .where(( f, g) => g.and ( 
       f.__deletedAt.eq(null), 
       f.service. link(Context.data.service) 
   )) 
   .first();

    Returns Promise<ProcessInstanceItem | undefined>

from

  • from(n: number): this

  • The Search.from method allows you to skip a specified number of results.

    Parameters

    • n: number

    Returns this

size

  • size(n: number): this

  • The method is used to limit the number of returned search results.

    Parameters

    • n: number

    Returns this

sort

  • sort(field: keyof ProcessInstanceData, ascending?: undefined | false | true): this

  • The method is used to sort search results.

    If the results need to be sorted by different parameters, you can call the method sequentially several times.

    Parameters

    • field: keyof ProcessInstanceData
    • Optional ascending: undefined | false | true

    Returns this

where

  • where(fc: F): this
  • where(eql: EqlQuery, params?: EqlParams): this

  • The Search.where method is used to set a filter for items in the collection.

    Parameters

    • fc: F

    Returns this

  • The Search.where method is used to set a filter for items in the collection.

    Parameters

    • eql: EqlQuery
    • Optional params: EqlParams

    Returns this