Options
All
  • Public
  • Public/Protected
  • All
Menu

Controls which page to load

Hierarchy

Index

Constructors

constructor

Properties

app

app: IApp

The App the ManagerItem is attached to

cacheIgnore

cacheIgnore: boolean | TypeIgnoreURLsList

URLs to ignore caching

config

config: ICONFIG

The Config of the App the ManagerItem is attached to

emitter

emitter: EventEmitter

The EventEmitter of the App the ManagerItem is attached to

key

key: any

The key to where ManagerItem is stored in an AdvancedManager

loading

loading: Manager<string, Promise<string>> = ...

Stores all fetch requests that are currently loading

manager

The AdvancedManager the ManagerItem is attached to

pages

pages: AdvancedManager<string, Page>

Accessors

size

  • get size(): number
  • Returns number

Methods

add

  • Parameters

    Returns PageManager

boot

  • boot(...args: any): any
  • Called on start of Service

    Parameters

    • Rest ...args: any

    Returns any

clear

  • Returns PageManager

get

  • get(key: string): Page
  • Parameters

    • key: string

    Returns Page

has

  • has(key: string): boolean
  • Parameters

    • key: string

    Returns boolean

init

  • init(...args: any): any
  • Called before the start of a Service, represents a constructor of sorts

    Parameters

    • Rest ...args: any

    Returns any

initEvents

  • initEvents(): void
  • Initialize events

    Returns void

install

  • install(): void
  • Instantiate pages, and add the current page to pages

    Returns void

keys

  • keys(): string[]
  • Returns string[]

load

  • load(_url?: string | URL): Promise<Page>
  • Load from cache or by requesting URL via a fetch request, avoid requesting for the same thing twice by storing the fetch request in "this.loading"

    Parameters

    • _url: string | URL = ...

    Returns Promise<Page>

register

remove

  • Parameters

    • key: string

    Returns PageManager

request

  • request(url: string): Promise<string>
  • Starts a fetch request

    Parameters

    • url: string

    Returns Promise<string>

set

  • Parameters

    Returns PageManager

stop

  • stop(): void
  • Stop Service

    Returns void

stopEvents

  • stopEvents(): void
  • Stop events

    Returns void

uninstall

  • uninstall(): any
  • Run before the ManagerItem has been unregistered

    Returns any

unregister

  • unregister(): void
  • Basically removes a ManagerItem, in order to recover the ManagerItem, it needs to be re-added to an AdvancedManager

    Returns void

Generated using TypeDoc