constructor

• new Store(opts?: StoreOpts): Store

• Returns Store

Private _resources

_resources: any

Private Optional agent

agent?: any

Private client

client: any

Private eventManager

eventManager: any

Private findAvailableSubject

findAvailableSubject: any

Private injectedFetch

injectedFetch: any

Private randomPart

randomPart: any

Private serverUrl

serverUrl: any

subscribers

Private webSockets

webSockets: any

resources

• get resources(): Map<string, Resource>

• Returns Map<string, Resource>

addResource

• addResource(resource: Resource): void

• Returns void

addResources

• addResources(...resources: Resource[]): void

• Parameters

  • Rest ...resources: Resource[]

  Returns void

buildUniqueSubjectFromParts

• buildUniqueSubjectFromParts(...parts: string[]): Promise<string>

• Parameters

  • Rest ...parts: string[]

  Returns Promise<string>

checkSubjectTaken

• checkSubjectTaken(subject: string): Promise<boolean>

• Parameters

  • subject: string

  Returns Promise<boolean>

createSubject

• createSubject(className?: string, parentSubject?: string): string

• Parameters

  • Optional className: string

  • Optional parentSubject: string

  Returns string

fetchResourceFromServer

• fetchResourceFromServer(subject: string, opts?: { body?: string | ArrayBuffer; fromProxy?: boolean; method?: "GET" | "POST"; noWebSocket?: boolean; setLoading?: boolean }): Promise<Resource>

• Parameters

  • subject: string

  • Optional opts: { body?: string | ArrayBuffer; fromProxy?: boolean; method?: "GET" | "POST"; noWebSocket?: boolean; setLoading?: boolean }

    • Optional body?: string | ArrayBuffer

    • Optional fromProxy?: boolean

    • Optional method?: "GET" | "POST"

    • Optional noWebSocket?: boolean

    • Optional setLoading?: boolean

  Returns Promise<Resource>

getAgent

• getAgent(): undefined | Agent

• Returns undefined | Agent

getAllSubjects

• getAllSubjects(): string[]

• Returns string[]

getDefaultWebSocket

• getDefaultWebSocket(): undefined | WebSocket

• Returns undefined | WebSocket

getProperty

• getProperty(subject: string): Promise<Property>

• Parameters

  • subject: string

  Returns Promise<Property>

getResourceAncestry

• getResourceAncestry(resource: Resource): Promise<string[]>

• Returns Promise<string[]>

getResourceAsync

• getResourceAsync(subject: string): Promise<Resource>

• Parameters

  • subject: string

  Returns Promise<Resource>

getResourceLoading

• getResourceLoading(subject?: string, opts?: FetchOpts): Resource

• Parameters

  • Optional subject: string

  • Optional opts: FetchOpts

  Returns Resource

getServerUrl

• getServerUrl(): string

• Returns string

getWebSocketForSubject

• getWebSocketForSubject(subject: string): undefined | WebSocket

• Parameters

  • subject: string

  Returns undefined | WebSocket

injectFetch

• injectFetch(fetchOverride: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)): void

• Parameters

  • fetchOverride: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

    • • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

      • Parameters

        • input: RequestInfo | URL

        • Optional init: RequestInit

        Returns Promise<Response>

  Returns void

isOffline

• isOffline(): boolean

• Returns boolean

notify

• notify(resource: Resource): Promise<void>

• Returns Promise<void>

notifyError

• notifyError(e: string | Error): void

• Parameters

  • e: string | Error

  Returns void

notifyResourceManuallyCreated

• notifyResourceManuallyCreated(resource: Resource): void

• Returns void

notifyResourceSaved

• notifyResourceSaved(resource: Resource): void

• Returns void

on

• on<T>(event: T, callback: StoreEventHandlers[T]): (() => void)

• Returns (() => void)

  • • (): void

    • Returns void

openWebSocket

• openWebSocket(url: string): void

• Parameters

  • url: string

  Returns void

parseMetaTags

• parseMetaTags(): void

• Returns void

postCommit

• postCommit(commit: Commit, endpoint: string): Promise<Commit>

• Parameters

  • commit: Commit

  • endpoint: string

  Returns Promise<Commit>

postToServer

• postToServer(url: string, data: string | ArrayBuffer): Promise<Resource>

• Parameters

  • url: string

  • data: string | ArrayBuffer

  Returns Promise<Resource>

preloadPropsAndClasses

• preloadPropsAndClasses(): Promise<void>

• Returns Promise<void>

removeResource

• removeResource(subject: string): void

• Parameters

  • subject: string

  Returns void

renameSubject

• renameSubject(resource: Resource, newSubject: string): Promise<void>

• Parameters

  • resource: Resource

  • newSubject: string

  Returns Promise<void>

setAgent

• setAgent(agent: undefined | Agent): void

• Parameters

  • agent: undefined | Agent

  Returns void

setServerUrl

• setServerUrl(url: string): void

• Parameters

  • url: string

  Returns void

subscribe

• subscribe(subject: string, callback: ResourceCallback): void

• Returns void

subscribeWebSocket

• subscribeWebSocket(subject: string): void

• Parameters

  • subject: string

  Returns void

unSubscribeWebSocket

• unSubscribeWebSocket(subject: string): void

• Parameters

  • subject: string

  Returns void

unsubscribe

• unsubscribe(subject: string, callback: ResourceCallback): void

• Returns void

uploadFiles

• uploadFiles(files: File[], parent: string): Promise<string[]>

• Parameters

  • files: File[]

  • parent: string

  Returns Promise<string[]>