Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FetchStrategy

FetchStrategy is an 'Enum' that determines how and where entities are retrieved from as a result of a query.

Hierarchy

Index

Constructors

constructor

Properties

_$typeName

_$typeName: string

Type of the enum; set in prototype of each enum

name

name: string

The name of this symbol

Static FromLocalCache

FromLocalCache: FetchStrategy = new FetchStrategy()

FromLocalCache is used to tell the query to execute the query against a local EntityManager instead of going to a remote server.

Static FromServer

FromServer: FetchStrategy = new FetchStrategy()

FromServer is used to tell the query to execute the query against a remote data source on the server.

Methods

toJSON

  • toJSON(): { _$typeName: any; name: string }
  • Return enum name and symbol name

    Returns { _$typeName: any; name: string }

    • _$typeName: any
    • name: string

toString

  • toString(): string

Static contains

  • Returns whether an Enum contains a specified symbol.

    let symbol = DayOfWeek.Friday;
    if (DayOfWeek.contains(symbol)) {
        // do something
    }
    

    Parameters

    Returns boolean

    Whether this Enum contains the specified symbol.

Static fromName

  • fromName(name: string): any
  • Returns an Enum symbol given its name.

    let dayOfWeek = DayOfWeek.from("Thursday");
    // nowdayOfWeek === DayOfWeek.Thursday
    

    Parameters

    • name: string

      Name for which an enum symbol should be returned.

    Returns any

    The symbol that matches the name or 'undefined' if not found.

Static getNames

  • getNames(): string[]
  • Returns the names of all of the symbols contained within this Enum.

    let symbols = DayOfWeek.getNames();
    

    Returns string[]

    All of the names of the symbols contained within this Enum.

Static getSymbols

  • Returns all of the symbols contained within this Enum.

    let symbols = DayOfWeek.getSymbols();
    

    Returns BreezeEnum[]

    All of the symbols contained within this Enum.

Static resolveSymbols

  • resolveSymbols(): { name: string; symbol: BreezeEnum }[]
  • Seals this enum so that no more symbols may be added to it. This should only be called after all symbols have already been added to the Enum. This method also sets the 'name' property on each of the symbols.

    DayOfWeek.resolveSymbols();
    

    Returns { name: string; symbol: BreezeEnum }[]

Generated using TypeDoc