Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IndexEntriesStore

stores Index entries

export

Hierarchy

  • AppDataStore<MenuDisplayItemModel[], any>
    • IndexEntriesStore

Implements

  • OnDestroy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private indexOptions

indexOptions: IndexOptions

isBusy

isBusy: boolean

Returns true when the API call is busy.

isError

isError: boolean

Returns true when the last API promise is rejected.

isLoaded

isLoaded: boolean

Returns true when the last API call loaded data without any errors.

options

options: AppDataStoreOptions<MenuDisplayItemModel[], any>

Returns the store options.

serviceData

serviceData: Observable<MenuDisplayItemModel[]>

Observes the service data.

serviceError

serviceError: Observable<any>

Observes any service errors.

Protected subscriptions

subscriptions: Subscription[]

Methods

Protected indicateError

  • indicateError(uri: string, error: any): void

  • indicate the error state

    Parameters

    • uri: string
    • error: any

    Returns void

initializeLoadState

  • initializeLoadState(): void

  • Initializes App data-loading state.

    Returns void

load

  • load(uri: string, options?: HttpClientOptions): void

  • Load domain data from the specified URI.

    Parameters

    • uri: string
    • Optional options: HttpClientOptions

    Returns void

loadAsync

  • loadAsync(uri: string, options?: HttpClientOptions): Promise<object>

  • Load domain data from the specified URI.

    Parameters

    • uri: string
    • Optional options: HttpClientOptions

    Returns Promise<object>

ngOnDestroy

  • ngOnDestroy(): void

  • A lifecycle hook that is called when a directive, pipe, or service is destroyed.

    Returns void

send

  • send(method: SendMethods, uri: string, body?: __type | null, options?: HttpClientOptions): void

  • Sends domain data to the specified URI.

    Parameters

    • method: SendMethods
    • uri: string
    • Optional body: __type | null
    • Optional options: HttpClientOptions

    Returns void

sendAsync

  • sendAsync(method: SendMethods, uri: string, body?: __type | null, options?: HttpClientOptions): Promise<object>

  • Sends domain data to the specified URI.

    Parameters

    • method: SendMethods
    • uri: string
    • Optional body: __type | null
    • Optional options: HttpClientOptions

    Returns Promise<object>

Protected setupObservables

  • setupObservables(): void

  • sets up reactive members of this data store

    remarks

    any sub-class setting up options will have to call this method again

    Returns void

Static filterEntries

  • filterEntries(entries: MenuDisplayItemModel[], particle: string): MenuDisplayItemModel[]

Generated using TypeDoc