Interface QueryStringBuilder

interface QueryStringBuilder {
    and(): this;
    or(): this;
    exact(): this;
    noExact(): this;
    exclude(): this;
    noExclude(): this;
    terms(term: string, ...terms: string[]): this;
    named(name: string, term: string, ...terms: string[]): this;
    label(label: string, ...labels: string[]): this;
    categories(category: string, ...categories: string[]): this;
    labels(label: string, ...labels: string[]): this;
    author(author: string, ...authors: string[]): this;
    title(title: string, ...titles: string[]): this;
    build(): MaybeString;
}

Methods

and or exact noExact exclude noExclude terms named label categories labels author title build

Methods

and

  • and(): this

  • Changes the operator to append search terms to AND.

    Returns this

    Example

    builder
      .labels('first')
      .and()
      .labels('second')
      .build() // 'label:first label:second'

    See

or

  • or(): this

  • Changes the operator to append search terms to OR.

    Returns this

    Example

    builder
      .labels('first')
      .or()
      .labels('second')
      .build() // 'label:first|label:second'

    See

exact

  • exact(): this

  • Sets the exact mode on.

    The next search terms will be exact.

    Returns this

    Example

    builder
      .labels('first')
      .and().exact()
      .labels('second label') // for labels with spaces, It's recommended to use exact mode.
      .build() // 'label:first label:"second label"'

    See

noExact

  • noExact(): this

  • Sets the exact mode off.

    The next search terms will not be exact.

    Returns this

    Example

    builder
      .exact()
      .labels('first label') // for labels with spaces, It's recommended to use exact mode.
      .or().noExact()
      .labels('second')
      .build() // 'label:"first label"|label:second'

    See

exclude

  • exclude(): this

  • Sets the exclude mode on.

    The next search terms will be exclusive.

    Returns this

    Example

    builder
      .labels('first')
      .and().exclude()
      .labels('second')
      .build() // 'label:first -label:second'

    See

noExclude

  • noExclude(): this

  • Sets the exclude mode off.

    The next search terms will not be exclusive.

    Returns this

    Example

    builder
      .labels('first')
      .and().exclude()
      .labels('second')
      .noExclude()
      .labels('third')
      .build() // 'label:first -label:second label:third'

    See

terms

  • terms(term, ...terms): this

  • Appends search terms to the query.

    Parameters

    • term: string

      The search term.

    • Rest...terms: string[]

      Other search terms.

    Returns this

    Example

    builder
       .terms('search', 'terms')
       .build() // 'search|terms'

named

  • named(name, term, ...terms): this

  • Appends named search terms to the query.

    Parameters

    • name: string

      The name of the search terms.

    • term: string

      The search term.

    • Rest...terms: string[]

      Other search terms.

    Returns this

    Example

    builder
       .named('label', 'search', 'label')
       .build() // 'label:search|label:label'

label

  • label(label, ...labels): this

  • Appends label search terms to the query.

    Parameters

    • label: string

      The label names.

    • Rest...labels: string[]

      Other label names

    Returns this

    Example

    builder.label(label) // .named('label', label)

    See

    Since

    1.2

categories

  • categories(category, ...categories): this

  • Appends category search terms to the query.

    Parameters

    • category: string

      The category name.

    • Rest...categories: string[]

      Other category names.

    Returns this

    See

    Remarks

    This is an alias for label

labels

  • labels(label, ...labels): this

  • Appends label search terms to the query.

    Parameters

    • label: string

      The label name.

    • Rest...labels: string[]

      Other label names.

    Returns this

    See

    Remarks

    This is an alias for label

author

  • author(author, ...authors): this

  • Appends author search terms to the query.

    Parameters

    • author: string

      The author name.

    • Rest...authors: string[]

      Other author names.

    Returns this

    Example

    builder.author(author) // .named('author', author)

    See

    Since

    1.2

title

  • title(title, ...titles): this

  • Appends title search terms to the query.

    Parameters

    • title: string

      The entry title.

    • Rest...titles: string[]

      Other entry titles.

    Returns this

    Example

    builder.title(title) // .title('title', title)

    Since

    1.2

build

  • build(): MaybeString

  • Returns the built query string. If It's empty, an undefined value is returned.

    Returns MaybeString

On This Page

Methods