Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FetchRequest

Hierarchy

  • FetchRequest

Index

Methods

Abstract after

  • Parameters

    • topicPath: string

    Returns FetchRequest

    a new fetch request derived from this fetch request but selecting only topics after the specified path (not inclusive)

Abstract before

  • Parameters

    • topicPath: string

    Returns FetchRequest

    a new fetch request derived from this fetch request but selecting only topics before the specified path (not inclusive)

Abstract fetch

  • Parameters

    Returns Result<FetchResult<any>>

    a Result that resolves with a FetchResult when a response is received from the server with the results of the fetch operation.

    If the task completes successfully, the FetchResult returned by the Result will be an object encapsulating all of the results.

    Otherwise, the Result will resolve with an Error. Common reasons for failure, listed by the error type, include:

  • Parameters

    Returns Result<FetchResult<any>>

Abstract first

  • Parameters

    • count: number

    Returns FetchRequest

    a new fetch request derived from this fetch request but selecting only the number of topics specified from the start of the range

Abstract from

  • Parameters

    • topicPath: string

    Returns FetchRequest

    a new fetch request derived from this fetch request but selecting only topics from the specified path onwards (inclusive)

Abstract last

  • Parameters

    • count: number

    Returns FetchRequest

    a new fetch request derived from this fetch request but selecting only the number of topics specified from the end of the range

Abstract limitDeepBranches

  • limitDeepBranches(deepBranchDepth: number, deepBranchLimit: number): FetchRequest
  • Parameters

    • deepBranchDepth: number
    • deepBranchLimit: number

    Returns FetchRequest

    a new fetch request derived from this fetch request but restricting the number of results for deep branches

Abstract maximumResultSize

  • Parameters

    • maximumSize: number

    Returns FetchRequest

    a new fetch request derived from this fetch request but constraining the size of the result to the specified maximum

Abstract to

  • Parameters

    • topicPath: string

    Returns FetchRequest

    a new fetch request derived from this fetch request but selecting only topics including and before the specified path (inclusive)

Abstract topicTypes

  • Parameters

    Returns FetchRequest

    a new fetch request derived from this fetch request but specifying that only topics of the specified topic types should be returned.

Abstract withProperties

  • Returns FetchRequest

    a new fetch request derived from this fetch request but specifying that topic specification properties should be returned.

Abstract withSizes

  • Returns FetchRequest

    a new fetch request derived from this fetch request but specifying that topic sizes should be returned.

Abstract withUnpublishedDelayedTopics

  • Returns FetchRequest

    a new fetch request derived from this fetch request, additionally specifying that unpublished reference topics should be included in the results

Abstract withValues

  • Parameters

    Returns FetchRequest

    a new fetch request derived from this fetch request but specifying that only topics compatible with the specified class should be returned with values.

Static getAllTypes

  • Returns Set<TopicType>

    the topic types that can be fetched by a FetchRequest