diff --git a/papi-dts/classes/_client_services_client_network_connector_service_.default.html b/papi-dts/classes/_client_services_client_network_connector_service_.default.html index 550acdc886..f70abf8c77 100644 --- a/papi-dts/classes/_client_services_client_network_connector_service_.default.html +++ b/papi-dts/classes/_client_services_client_network_connector_service_.default.html @@ -1,5 +1,5 @@ default | papi-dts

Handles the connection from the client to the server

-

Implements

Constructors

Implements

Constructors

Properties

clientGuid: any

Unique Guid associated with this connection. Used to verify certain things with server

-
connect: ((localRequestHandler, requestRouter, localEventHandler) => Promise<Readonly<{
    clientId: number;
}>>)

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing +

connect: ((localRequestHandler, requestRouter, localEventHandler) => Promise<Readonly<{
    clientId: number;
}>>)

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing one of the following:

  • On Client: connecting to the server.
  • @@ -42,61 +42,61 @@

    Param: localEventHandler

    Function that handles events from the server

    Param: networkConnectorEventHandlers

    Functions that run when network connector events occur like when clients are disconnected

    Returns

    Promise that resolves with connector info when finished connecting

    -
connectPromise?: any

Promise that resolves when the connection is finished or rejects if disconnected before the +

connectPromise?: any

Promise that resolves when the connection is finished or rejects if disconnected before the connection finishes

-
connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to +

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-
connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

-

Type declaration

  • clientId: number
disconnect: (() => void)

Disconnects from the connection:

+
connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number
disconnect: (() => void)

Disconnects from the connection:

  • On Client: disconnects from the server
  • On Server: disconnects from clients and closes its connection endpoint
-

Type declaration

    • (): void
    • Returns void

emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

Type declaration

    • (): void
    • Returns void

emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

Type declaration

    • <T>(eventType, event): Promise<void>
    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

Param: eventType

Unique network event type for coordinating between processes

Param: event

Event to emit on the network

-
handleEventMessage: any

Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided +

handleEventMessage: any

Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided in connect()

Param: eventMessage

Event message to handle

-
handleRequestMessage: any

Function that handles incoming webSocket messages and locally sent messages of type Request. +

handleRequestMessage: any

Function that handles incoming webSocket messages and locally sent messages of type Request. Runs the requestHandler provided in connect() and sends a message with the response

Param: requestMessage

Request message to handle

Param: isIncoming

Whether this message is coming from the server and we should definitely handle it locally or if it is a locally sent request and we should send to the server if we don't have a local handler

-
handleResponseMessage: any

Function that handles webSocket messages of type Response. Resolves the request associated with +

handleResponseMessage: any

Function that handles webSocket messages of type Response. Resolves the request associated with the received response message

Param: response

Response message to resolve

-
localEventHandler?: any

Function to call when we receive an event. Handles events from the connection by emitting the +

localEventHandler?: any

Function to call when we receive an event. Handles events from the connection by emitting the event locally

-
localRequestHandler?: any

Function to call when we receive a request that is registered on this connector. Handles +

localRequestHandler?: any

Function to call when we receive a request that is registered on this connector. Handles requests from the connection and returns a response to send back

-
messageEmitters: any

All message subscriptions - emitters that emit an event each time a message with a specific +

messageEmitters: any

All message subscriptions - emitters that emit an event each time a message with a specific message type comes in

-
notifyClientConnected: (() => Promise<void>)

Notify the server that this client has received its connectorInfo and is ready to go.

+
notifyClientConnected: (() => Promise<void>)

Notify the server that this client has received its connectorInfo and is ready to go.

MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

TODO: Is this necessary?

-

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

onMessage: any

Receives and appropriately publishes server webSocket messages

+

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

onMessage: any

Receives and appropriately publishes server webSocket messages

Param: event

WebSocket message information

Param: fromSelf

Whether this message is from this connector instead of from someone else

-
request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

Send a request to the server/a client and resolve after receiving a response

+
request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

Send a request to the server/a client and resolve after receiving a response

Type declaration

Param: requestType

The type of request

Param: contents

Contents to send in the request

Returns

Promise that resolves with the response message

-
requestRouter?: any

Function to call when we are sending a request. Returns a clientId to which to send the request +

requestRouter?: any

Function to call when we are sending a request. Returns a clientId to which to send the request based on the requestType

-
requests: any

All requests that are waiting for a response

-
sendMessage: any

Send a message to the server via webSocket. Throws if not connected

+
requests: any

All requests that are waiting for a response

+
sendMessage: any

Send a message to the server via webSocket. Throws if not connected

Param: message

Message to send

-
subscribe: any

Subscribes a function to run on webSocket messages of a particular type

+
subscribe: any

Subscribes a function to run on webSocket messages of a particular type

Param: messageType

The type of message on which to subscribe the function

Param: callback

Function to run with the contents of the webSocket message

Returns

Unsubscriber function to run to stop calling the passed-in function on webSocket messages

-
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-
unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

-
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

-
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

-
webSocket?: any

The webSocket connected to the server

-

Generated using TypeDoc

\ No newline at end of file +
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+
unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

+
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

+
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

+
webSocket?: any

The webSocket connected to the server

+

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_main_services_server_network_connector_service_.default.html b/papi-dts/classes/_main_services_server_network_connector_service_.default.html index 0526ab3afa..e1c9b53dea 100644 --- a/papi-dts/classes/_main_services_server_network_connector_service_.default.html +++ b/papi-dts/classes/_main_services_server_network_connector_service_.default.html @@ -1,5 +1,5 @@ default | papi-dts

Handles the endpoint and connections from the server to the clients

-

Implements

Constructors

Implements

Constructors

Properties

clientSockets: any

The webSocket clients that are connected and information about them

-
connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
    clientId: number;
}>>)

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing +

connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
    clientId: number;
}>>)

Sets up the NetworkConnector by populating connector info, setting up event handlers, and doing one of the following:

  • On Client: connecting to the server.
  • @@ -51,79 +51,79 @@

    Param: localEventHandler

    Function that handles events from the server

    Param: networkConnectorEventHandlers

    Functions that run when network connector events occur like when clients are disconnected

    Returns

    Promise that resolves with connector info when finished connecting

    -
connectPromise?: any

Promise that resolves when finished starting the server or rejects if disconnected before the +

connectPromise?: any

Promise that resolves when finished starting the server or rejects if disconnected before the server finishes

-
connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to +

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-
connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

-

Type declaration

  • clientId: number
disconnect: (() => void)

Disconnects from the connection:

+
connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number
disconnect: (() => void)

Disconnects from the connection:

  • On Client: disconnects from the server
  • On Server: disconnects from clients and closes its connection endpoint
-

Type declaration

    • (): void
    • Returns void

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

-
emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

Type declaration

    • (): void
    • Returns void

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

+
emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

Type declaration

    • <T>(eventType, event): Promise<void>
    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

Param: eventType

Unique network event type for coordinating between processes

Param: event

Event to emit on the network

-
getClientIdFromSocket: any

Get the clientId for a certain webSocket. Throws if not found

-
getClientSocket: any

Get the client socket for a certain clientId. Throws if not found

-
getClientSocketFromGuid: any

Attempts to get the client socket for a certain clientGuid. Returns undefined if not found. +

getClientIdFromSocket: any

Get the clientId for a certain webSocket. Throws if not found

+
getClientSocket: any

Get the client socket for a certain clientId. Throws if not found

+
getClientSocketFromGuid: any

Attempts to get the client socket for a certain clientGuid. Returns undefined if not found. This does not throw because it will likely be very common that we do not have a clientId for a certain clientGuid as connecting clients will often supply old clientGuids.

-
handleClientConnectMessage: any

Function that handles webSocket messages of type ClientConnect. Mark the connection fully +

handleClientConnectMessage: any

Function that handles webSocket messages of type ClientConnect. Mark the connection fully connected and notify that a client connected or reconnected

Param: clientConnect

Message from the client about the connection

Param: connectorId

ClientId of the client who is sending this ClientConnect message

-
handleEventMessage: any

Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided +

handleEventMessage: any

Function that handles incoming webSocket messages of type Event. Runs the eventHandler provided in connect() and forwards the event to other clients

Param: eventMessage

Event message to handle

-
handleRequestMessage: any

Function that handles incoming webSocket messages and locally sent messages of type Request. +

handleRequestMessage: any

Function that handles incoming webSocket messages and locally sent messages of type Request. Handles the request and sends a response if we have a handler or forwards to the appropriate client

Param: requestMessage

Request to handle

Param: requesterId

Who sent this message

-
handleResponseMessage: any

Function that handles webSocket messages of type Response. Resolves the request associated with +

handleResponseMessage: any

Function that handles webSocket messages of type Response. Resolves the request associated with the received response message or forwards to appropriate client

Param: response

Response message to resolve

Param: responderId

Responding client

-
localEventHandler?: any

Function to call when we receive an event. Handles events from connections and emits the event +

localEventHandler?: any

Function to call when we receive an event. Handles events from connections and emits the event locally

-
localRequestHandler?: any

Function to call when we receive a request that is registered on this connector. Handles +

localRequestHandler?: any

Function to call when we receive a request that is registered on this connector. Handles requests from connections and returns a response to send back

-
messageEmitters: any

All message subscriptions - emitters that emit an event each time a message with a specific +

messageEmitters: any

All message subscriptions - emitters that emit an event each time a message with a specific message type comes in

-
networkConnectorEventHandlers?: any

Functions to run when network connector events occur like when clients are disconnected

-
nextClientId: any

The next client id to use for a new connection. Starts at 1 because the server is 0

-
notifyClientConnected: (() => Promise<void>)

Notify the server that this client has received its connectorInfo and is ready to go.

+
networkConnectorEventHandlers?: any

Functions to run when network connector events occur like when clients are disconnected

+
nextClientId: any

The next client id to use for a new connection. Starts at 1 because the server is 0

+
notifyClientConnected: (() => Promise<void>)

Notify the server that this client has received its connectorInfo and is ready to go.

MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

TODO: Is this necessary?

-

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

onClientConnect: any

Registers an incoming webSocket connection and sends connection info with InitClient. Does not +

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

onClientConnect: any

Registers an incoming webSocket connection and sends connection info with InitClient. Does not consider the client fully connected yet until they respond and tell us they connected with ClientConnect

-
onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

-
onMessage: any

Receives and appropriately publishes webSocket messages

+
onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

+
onMessage: any

Receives and appropriately publishes webSocket messages

Param: event

WebSocket message information

Param: fromSelf

Whether this message is from this connector instead of from someone else

-
request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

Send a request to the server/a client and resolve after receiving a response

+
request: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

Send a request to the server/a client and resolve after receiving a response

Type declaration

Param: requestType

The type of request

Param: contents

Contents to send in the request

Returns

Promise that resolves with the response message

-
requestRouter?: any

Function to call when we are sending a request. Returns a clientId to which to send the request +

requestRouter?: any

Function to call when we are sending a request. Returns a clientId to which to send the request based on the requestType

-
requests: any

All requests that are waiting for a response

-
sendMessage: any

Send a message to a client via webSocket. Throws if not connected

+
requests: any

All requests that are waiting for a response

+
sendMessage: any

Send a message to a client via webSocket. Throws if not connected

Param: message

Message to send

Param: recipientId

The client to which to send the message. TODO: determine if we can intuit this instead

-
subscribe: any

Subscribes a function to run on webSocket messages of a particular type

+
subscribe: any

Subscribes a function to run on webSocket messages of a particular type

Param: messageType

The type of message on which to subscribe the function

Param: callback

Function to run with the contents of the webSocket message

Returns

Unsubscriber function to run to stop calling the passed-in function on webSocket messages

-
unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

-
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

-
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

-
webSocketServer?: any

The webSocket connected to the server

-

Generated using TypeDoc

\ No newline at end of file +
unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

+
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

+
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

+
webSocketServer?: any

The webSocket connected to the server

+

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html index 3028ca86fb..028496cd86 100644 --- a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html +++ b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html @@ -1,7 +1,7 @@ ExecutionToken | papi-dts

Execution tokens can be passed into API calls to provide context about their identity

-

Constructors

Constructors

Properties

Methods

Constructors

Properties

name: string
nonce: string
type: "extension"

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

name: string
nonce: string
type: "extension"

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html index 5f974657fe..1f0c86746e 100644 --- a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html @@ -2,7 +2,7 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

Note that the Node WebSocket implementation is different and not wrapped here.

-

Implements

Constructors

Implements

  • WebSocket

Constructors

Properties

Constructors

Properties

CLOSED: 3
CLOSING: 2
CONNECTING: 0
OPEN: 1
addEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof WebSocketEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

binaryType: BinaryType
bufferedAmount: number
close: ((code?, reason?) => void)

Type declaration

    • (code?, reason?): void
    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

extensions: string
onclose: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

onerror: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

onmessage: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

onopen: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

protocol: string
readyState: number
removeEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof WebSocketEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

send: ((data) => void)

Type declaration

    • (data): void
    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url: string

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

CLOSED: 3
CLOSING: 2
CONNECTING: 0
OPEN: 1
addEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof WebSocketEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

binaryType: BinaryType
bufferedAmount: number
close: ((code?, reason?) => void)

Type declaration

    • (code?, reason?): void
    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

extensions: string
onclose: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

onerror: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

onmessage: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

onopen: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

protocol: string
readyState: number
removeEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof WebSocketEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

send: ((data) => void)

Type declaration

    • (data): void
    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url: string

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html index 8ede90c464..08b419421f 100644 --- a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html @@ -2,7 +2,7 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

Note that Node doesn't have a native implementation, so this is only for the renderer.

-

Implements

Constructors

Implements

  • XMLHttpRequest

Constructors

Properties

Constructors

Properties

DONE: 4
HEADERS_RECEIVED: 2
LOADING: 3
OPENED: 1
UNSENT: 0
abort: (() => void)

Type declaration

    • (): void
    • Returns void

addEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof XMLHttpRequestEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders: (() => string)

Type declaration

    • (): string
    • Returns string

getResponseHeader: ((name) => null | string)

Type declaration

    • (name): null | string
    • Parameters

      • name: string

      Returns null | string

onabort: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onerror: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onload: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadend: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadstart: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onprogress: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onreadystatechange: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

ontimeout: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

open: ((method, url, async?, username?, password?) => void)

Type declaration

    • (method, url, async?, username?, password?): void
    • Parameters

      • method: string
      • url: string
      • Optional async: boolean
      • Optional username: null | string
      • Optional password: null | string

      Returns void

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void
    • Parameters

      • mime: string

      Returns void

readyState: number
removeEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof XMLHttpRequestEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

response: any
responseText: string
responseType: XMLHttpRequestResponseType
responseURL: string
responseXML: null | Document
send: ((body?) => void)

Type declaration

    • (body?): void
    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

setRequestHeader: ((name, value) => void)

Type declaration

    • (name, value): void
    • Parameters

      • name: string
      • value: string

      Returns void

status: number
statusText: string
timeout: number
upload: XMLHttpRequestUpload
withCredentials: boolean

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

DONE: 4
HEADERS_RECEIVED: 2
LOADING: 3
OPENED: 1
UNSENT: 0
abort: (() => void)

Type declaration

    • (): void
    • Returns void

addEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof XMLHttpRequestEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders: (() => string)

Type declaration

    • (): string
    • Returns string

getResponseHeader: ((name) => null | string)

Type declaration

    • (name): null | string
    • Parameters

      • name: string

      Returns null | string

onabort: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onerror: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onload: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadend: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadstart: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onprogress: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onreadystatechange: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

ontimeout: null | ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

open: ((method, url, async?, username?, password?) => void)

Type declaration

    • (method, url, async?, username?, password?): void
    • Parameters

      • method: string
      • url: string
      • Optional async: boolean
      • Optional username: null | string
      • Optional password: null | string

      Returns void

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void
    • Parameters

      • mime: string

      Returns void

readyState: number
removeEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void
    • Type Parameters

      • K extends keyof XMLHttpRequestEventMap

      Parameters

      • type: K
      • listener: ((this, ev) => any)
          • (this, ev): any
          • Parameters

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

response: any
responseText: string
responseType: XMLHttpRequestResponseType
responseURL: string
responseXML: null | Document
send: ((body?) => void)

Type declaration

    • (body?): void
    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

setRequestHeader: ((name, value) => void)

Type declaration

    • (name, value): void
    • Parameters

      • name: string
      • value: string

      Returns void

status: number
statusText: string
timeout: number
upload: XMLHttpRequestUpload
withCredentials: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html index 46f34ae761..92b2e8701b 100644 --- a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html +++ b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html @@ -2,6 +2,6 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

See

IDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Type Parameters

Hierarchy (view full)

Implements

Constructors

Methods

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html index 446ee140b9..71cf63c8e3 100644 --- a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html +++ b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html @@ -7,7 +7,7 @@

WARNING: Do not use this class directly outside of NetworkService, or it will not do what you expect. Use NetworkService.createNetworkEventEmitter.

WARNING: You cannot emit events with complex types on the network.

-

Type Parameters

Hierarchy

Constructors

Type Parameters

  • T

Hierarchy

  • PlatformEventEmitter<T>
    • default

Constructors

Properties

dispose emit networkDisposer @@ -21,22 +21,22 @@

Constructors

Properties

dispose: (() => Promise<boolean>)

Type declaration

    • (): Promise<boolean>
    • Returns Promise<boolean>

emit: ((event) => void)

Type declaration

    • (event): void
    • Parameters

      • event: T

      Returns void

networkDisposer: any

Callback that runs when the emitter is disposed - should handle unlinking from the network

-
networkSubscriber: any

Callback that sends the event to other processes on the network when it is emitted

-
subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+
    • (): void
    • Returns void

Returns "shared/models/papi-network-event-emitter.model".default<T>

Properties

dispose: (() => Promise<boolean>)

Type declaration

    • (): Promise<boolean>
    • Returns Promise<boolean>

emit: ((event) => void)

Type declaration

    • (event): void
    • Parameters

      • event: T

      Returns void

networkDisposer: any

Callback that runs when the emitter is disposed - should handle unlinking from the network

+
networkSubscriber: any

Callback that sends the event to other processes on the network when it is emitted

+
subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

Param: callback

Function to run with the event when it is emitted

Returns

Unsubscriber function to run to stop calling the passed-in function when the event is emitted

Alias

event

-

Accessors

Accessors

Methods

Methods

Generated using TypeDoc

\ No newline at end of file +

Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html index bfb7313c38..5f91f74549 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html @@ -8,7 +8,7 @@ If a Project Data Provider Engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

See

IProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

projectId: string
projectStorageInterpreter: ProjectStorageInterpreters[ProjectType]
projectStorageInterpreterId: string
psiExtensionDataUnsubscriberPromise: any
psiSettingUnsubscriberPromise: any

Methods

  • Disposes of this Project Data Provider Engine. Unsubscribes from listening to the Project +

  • projectStorageInterpreterId: string

Returns "shared/models/project-data-provider-engine.model".ProjectDataProviderEngine<ProjectType>

Properties

projectId: string
projectStorageInterpreter: ProjectStorageInterpreters[ProjectType]
projectStorageInterpreterId: string
psiExtensionDataUnsubscriberPromise: any
psiSettingUnsubscriberPromise: any

Methods

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html index 6785928092..23ed167808 100644 --- a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html +++ b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html @@ -1,5 +1,5 @@ EntryType | papi-dts

Type of file system item in a directory

-

Enumeration Members

Enumeration Members

Enumeration Members

Directory: "directory"
File: "file"
Unknown: "unknown"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Directory: "directory"
File: "file"
Unknown: "unknown"

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html b/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html index e5a3fa763e..73367aeaef 100644 --- a/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html +++ b/papi-dts/enums/_shared_data_internal_connection_model_.ConnectionStatus.html @@ -1,9 +1,9 @@ ConnectionStatus | papi-dts

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-

Enumeration Members

Enumeration Members

Enumeration Members

Connected: 2

This connector has finished setting up its connection - has connectorInfo and such

-
Connecting: 1

This connector is attempting to connect to the network and retrieve connectorInfo

-
Disconnected: 0

This connector is not connected to the network

-

Generated using TypeDoc

\ No newline at end of file +
Connecting: 1

This connector is attempting to connect to the network and retrieve connectorInfo

+
Disconnected: 0

This connector is not connected to the network

+

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html b/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html index 39fc2d4a96..da2d53212c 100644 --- a/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html +++ b/papi-dts/enums/_shared_data_network_connector_model_.MessageType.html @@ -1,7 +1,7 @@ MessageType | papi-dts

WebSocket message type that indicates how to handle it

-

Enumeration Members

Enumeration Members

ClientConnect: "client-connect"
Event: "event"
InitClient: "init-client"
Request: "request"
Response: "response"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ClientConnect: "client-connect"
Event: "event"
InitClient: "init-client"
Request: "request"
Response: "response"

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_global_this_model_.ProcessType.html b/papi-dts/enums/_shared_global_this_model_.ProcessType.html index e7006b0ab1..e3192b0a6c 100644 --- a/papi-dts/enums/_shared_global_this_model_.ProcessType.html +++ b/papi-dts/enums/_shared_global_this_model_.ProcessType.html @@ -1,5 +1,5 @@ ProcessType | papi-dts

Type of Paranext process

-

Enumeration Members

Enumeration Members

Enumeration Members

ExtensionHost: "extension-host"
Main: "main"
Renderer: "renderer"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ExtensionHost: "extension-host"
Main: "main"
Renderer: "renderer"

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html index 749f501d96..bbeec395b9 100644 --- a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html +++ b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html @@ -1,11 +1,11 @@ WebViewContentType | papi-dts

The type of code that defines a webview's content

-

Enumeration Members

Enumeration Members

Enumeration Members

HTML: "html"

This webview is a raw HTML/JS/CSS webview.

-
React: "react"

This webview is a React webview. It must specify its component by setting it to +

React: "react"

This webview is a React webview. It must specify its component by setting it to globalThis.webViewComponent

-
URL: "url"

This webview's content is fetched from the url specified (iframe src attribute). Note that +

URL: "url"

This webview's content is fetched from the url specified (iframe src attribute). Note that webViews of this type cannot access the papi because they cannot be on the same origin as the parent window.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html b/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html index f5fa718dd6..d9a69f78ef 100644 --- a/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html +++ b/papi-dts/enums/_shared_utils_util_.RequestHandlerType.html @@ -1,5 +1,5 @@ RequestHandlerType | papi-dts

Enumeration RequestHandlerType

Type of request handler - indicates what type of parameters and what return type the handler has

-

Enumeration Members

Enumeration Members

Enumeration Members

Args: "args"
Complex: "complex"
Contents: "contents"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Args: "args"
Complex: "complex"
Contents: "contents"

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/functions/__papi_backend_.fetch.html b/papi-dts/functions/__papi_backend_.fetch.html index 52d6f8c970..9907695445 100644 --- a/papi-dts/functions/__papi_backend_.fetch.html +++ b/papi-dts/functions/__papi_backend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts
  • This is just an alias for internet.fetch

    -

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • This is just an alias for internet.fetch

    -

    Parameters

    • input: string | Request | URL
    • Optional init: RequestInit

    Returns Promise<Response>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

    Returns Promise<Response>

  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/__papi_frontend_.fetch.html b/papi-dts/functions/__papi_frontend_.fetch.html index f27b0f38fb..6895e04d37 100644 --- a/papi-dts/functions/__papi_frontend_.fetch.html +++ b/papi-dts/functions/__papi_frontend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts
    • This is just an alias for internet.fetch

      -

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    • This is just an alias for internet.fetch

      -

      Parameters

      • input: string | Request | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

    Returns Promise<Response>

  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html index 5685b7bfab..ca18501dd9 100644 --- a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html +++ b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html @@ -1,3 +1,3 @@ createWebSocket | papi-dts
    • Creates a WebSocket for the renderer or extension host depending on where you're running

      Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html index a822123b99..42783edf35 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html @@ -1,2 +1,2 @@ buildExtensionPathFromName | papi-dts
    • Return a path to the specified file within the extension's installation directory

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html index e3a7a798eb..08b1cc2987 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html @@ -1,3 +1,3 @@ setExtensionUris | papi-dts
    • This is only intended to be called by the extension service. This service cannot call into the extension service or it causes a circular dependency.

      -

      Parameters

      • urisPerExtension: Map<string, string>

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html index 08d954c38d..0202c4ec30 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html @@ -5,4 +5,4 @@
  • Optional mode: number

    Bitwise modifiers that affect how the copy works. See fsPromises.copyFile for more information

    -
  • Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html index 688c1036a2..d03ba7ade9 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html @@ -1,4 +1,4 @@ createDir | papi-dts
    • Create a directory in the file system if it does not exist. Does not throw if it already exists.

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves once the directory has been created

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html index 77b1b68124..17f4da0b9f 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html @@ -1,4 +1,4 @@ deleteDir | papi-dts
    • Remove a directory and all its contents recursively from the file system

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves when the delete operation finishes

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html index 866ffe2a0a..687dbc6bef 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html @@ -1,4 +1,4 @@ deleteFile | papi-dts
    • Delete a file if it exists

      Parameters

      • uri: string

        URI of file

      Returns Promise<void>

      Promise that resolves when the file is deleted or determined to not exist

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html index 6eccab814f..7e5c4b9fef 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<BigIntStats | undefined>

    Promise that resolves to object of type https://nodejs.org/api/fs.html#class-fsstats if file or directory exists, undefined if it doesn't

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html index 75405c8932..3ce57bde41 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<DirectoryEntries>

    Map of entry type to list of uris for each entry in the directory with that type.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html index 2f0b91b185..095c92da5a 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html @@ -1,4 +1,4 @@ readFileBinary | papi-dts
    • Read a binary file

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html index 89347bf857..9cd9592008 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html @@ -1,4 +1,4 @@ readFileText | papi-dts
    • Read a text file

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.touch.html b/papi-dts/functions/_node_services_node_file_system_service_.touch.html index b8b29c2771..2fd2acf63a 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.touch.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.touch.html @@ -1,4 +1,4 @@ touch | papi-dts
    • Set the last modified and accessed times for the file or directory

      Parameters

      • uri: string

        URI of file or directory

      • date: Date

      Returns Promise<void>

      Promise that resolves once the touch operation finishes

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html index 910f740f41..af036ecb69 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<void>

    Promise that resolves after writing the file

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index 5c41123573..3302ac12ca 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html @@ -1,4 +1,4 @@ createNonce | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html index d95858af99..5fa7308db8 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html @@ -1 +1 @@ -createUuid | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +createUuid | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.getAppDir.html b/papi-dts/functions/_node_utils_util_.getAppDir.html index 4d01bef322..ea318db3fd 100644 --- a/papi-dts/functions/_node_utils_util_.getAppDir.html +++ b/papi-dts/functions/_node_utils_util_.getAppDir.html @@ -1,5 +1,5 @@ getAppDir | papi-dts
    • Gets the platform-specific user Platform.Bible folder for this application

      When running in development: <repo_directory>/dev-appdata

      When packaged: <user_home_directory>/.platform.bible

      -

      Parameters

      • this: unknown
      • Rest ...args: []

      Returns string

    Properties

    Parameters

    • this: unknown
    • Rest ...args: []

    Returns string

    Properties

    Properties

    clear: (() => void)

    Type declaration

      • (): void
      • Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index 9dcc5185a7..652152c0ed 100644 --- a/papi-dts/functions/_node_utils_util_.getPathFromUri.html +++ b/papi-dts/functions/_node_utils_util_.getPathFromUri.html @@ -1,4 +1,4 @@ getPathFromUri | papi-dts
    • Resolves the uri to a path

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index 10e21b722b..037dc13b9c 100644 --- a/papi-dts/functions/_node_utils_util_.joinUriPaths.html +++ b/papi-dts/functions/_node_utils_util_.joinUriPaths.html @@ -2,4 +2,4 @@

    Parameters

    Returns Uri

    One uri that combines the uri and the paths in left-to-right order

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html index a2f015a1cb..ca7f78d913 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +resolveHtmlPath | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html index b5845fd3bf..53905a0a38 100644 --- a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html +++ b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html @@ -3,4 +3,4 @@ mitigate a dependency cycle

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html index df7894a428..7462cd7147 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns UseDataHookGeneric<TUseDataProviderParams>

    useData hook for getting data from a data provider

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html index bdaca671cd..917c24c197 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html @@ -9,4 +9,4 @@ (result of this hook, if you want this hook to just return the network object again)

    Returns ((...args) => NetworkObject<object> | undefined)

    A function that takes in a networkObjectSource and returns a NetworkObject

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html index fbe70bff09..bfc06da8f0 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html @@ -29,4 +29,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [DataProviderTypes[DataProviderName][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<DataProviderTypes[DataProviderName]>>), boolean])
    }

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [DataProviderTypes[DataProviderName][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<DataProviderTypes[DataProviderName]>>), boolean])
    }

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html index a23d5a7a4e..5d0d5d7cad 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html @@ -3,4 +3,4 @@ useDataProvider, if you want this hook to just return the data provider again)

    Returns undefined | DataProviders[DataProviderName]

    Undefined if the data provider has not been retrieved, data provider if it has been retrieved and is not disposed, and undefined again if the data provider is disposed

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html index 1841233ee0..9db7c91713 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html @@ -9,4 +9,4 @@ dataProviderSources. Each item in the array will be (a) undefined if the data provider has not been retrieved or has been disposed, or (b) a data provider if it has been retrieved and is not disposed.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html index aeaff5d7d6..3a6d524d6c 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html @@ -59,7 +59,7 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook -
  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will +

  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will open a dialog with the provided dialogType and options then run the resolveCallback with the dialog response or rejectCallback if there is an error. By default, only one dialog can be open at a time.

    @@ -105,4 +105,4 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html index 42be18b545..e7011ef2ab 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html @@ -37,4 +37,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [ProjectDataTypes[ProjectType][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectDataTypes[ProjectType]>>), boolean])
    }

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns {
        [TDataType in string | number | symbol]: ((selector, defaultValue, subscriberOptions?) => [ProjectDataTypes[ProjectType][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectDataTypes[ProjectType]>>), boolean])
    }

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html index a27f73db93..b527cc97fa 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html @@ -9,4 +9,4 @@

    Returns undefined | ProjectDataProviders[ProjectType]

    undefined if the Project Data Provider has not been retrieved, the requested Project Data Provider if it has been retrieved and is not disposed, and undefined again if the Project Data Provider is disposed

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html index f5ce578348..26abd78549 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html @@ -31,4 +31,4 @@

    Throws

    When subscription callback function is called with an update that has an unexpected message type

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html index 12d9e6dcb8..70bc4de978 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html @@ -18,4 +18,4 @@

    Throws

    When subscription callback function is called with an update that has an unexpected message type

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html index 59d9c57917..5bc8875c36 100644 --- a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html +++ b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html @@ -1,2 +1,2 @@ blockWebSocketsToPapiNetwork | papi-dts
    • Once our network is running, run this to stop extensions from connecting to it directly

      -

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html index b08bc3d5af..33b02d5ba6 100644 --- a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html +++ b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html @@ -1,4 +1,4 @@ getDataProviderDataTypeFromFunctionName | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.addThree.html b/papi-dts/functions/_shared_services_command_service_.addThree.html index 158d490518..c447e0546f 100644 --- a/papi-dts/functions/_shared_services_command_service_.addThree.html +++ b/papi-dts/functions/_shared_services_command_service_.addThree.html @@ -1 +1 @@ -addThree | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +addThree | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html index 5f7b1803d3..c61a4b2496 100644 --- a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html +++ b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns ((...args) => Promise<Awaited<ReturnType<CommandHandlers[CommandName]>>>)

    Function to call with arguments of command that sends the command and resolves with the result of the command

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.initialize.html b/papi-dts/functions/_shared_services_command_service_.initialize.html index 4177bdb979..08272165f9 100644 --- a/papi-dts/functions/_shared_services_command_service_.initialize.html +++ b/papi-dts/functions/_shared_services_command_service_.initialize.html @@ -1,2 +1,2 @@ initialize | papi-dts
    • Sets up the CommandService. Only runs once and always returns the same promise after that

      -

      Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.registerCommand.html b/papi-dts/functions/_shared_services_command_service_.registerCommand.html index bf0b8b0118..0bb1ad67da 100644 --- a/papi-dts/functions/_shared_services_command_service_.registerCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.registerCommand.html @@ -6,4 +6,4 @@
  • handler: CommandHandlers[CommandName]

    Function to run when the command is invoked

  • Returns Promise<UnsubscriberAsync>

    True if successfully registered, throws with error message if not

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index dbc3e528d9..e62dee57ca 100644 --- a/papi-dts/functions/_shared_services_command_service_.sendCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.sendCommand.html @@ -1,2 +1,2 @@ sendCommand | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns Promise<Awaited<ReturnType<CommandHandlers[CommandName]>>>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html b/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html index da7b4a6553..8f4b903311 100644 --- a/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html +++ b/papi-dts/functions/_shared_services_command_service_.squareAndConcat.html @@ -1 +1 @@ -squareAndConcat | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +squareAndConcat | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.connect.html b/papi-dts/functions/_shared_services_connection_service_.connect.html index 32315c5a10..64fa50c21c 100644 --- a/papi-dts/functions/_shared_services_connection_service_.connect.html +++ b/papi-dts/functions/_shared_services_connection_service_.connect.html @@ -8,4 +8,4 @@
  • connectorEventHandlers: NetworkConnectorEventHandlers

    Functions that run when network connector events occur like when clients are disconnected

  • Returns Promise<void>

    Promise that resolves when finished connecting

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.disconnect.html b/papi-dts/functions/_shared_services_connection_service_.disconnect.html index 5f853b86c0..9549d32f8e 100644 --- a/papi-dts/functions/_shared_services_connection_service_.disconnect.html +++ b/papi-dts/functions/_shared_services_connection_service_.disconnect.html @@ -1,2 +1,2 @@ disconnect | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html b/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html index 30442f1693..dd1cdfa4c7 100644 --- a/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html +++ b/papi-dts/functions/_shared_services_connection_service_.emitEventOnNetwork.html @@ -2,4 +2,4 @@ run by NetworkEventEmitter after sending on network.

    Type Parameters

    Parameters

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.getClientId.html b/papi-dts/functions/_shared_services_connection_service_.getClientId.html index 1aeb80e7e6..ecfaf12675 100644 --- a/papi-dts/functions/_shared_services_connection_service_.getClientId.html +++ b/papi-dts/functions/_shared_services_connection_service_.getClientId.html @@ -1,2 +1,2 @@ getClientId | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.request.html b/papi-dts/functions/_shared_services_connection_service_.request.html index 3a03af549a..e8a87b98bd 100644 --- a/papi-dts/functions/_shared_services_connection_service_.request.html +++ b/papi-dts/functions/_shared_services_connection_service_.request.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns Promise<ComplexResponse<TReturn>>

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html index 507944d62f..d3ecaa8127 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html @@ -1,4 +1,4 @@ getByType | papi-dts
    • Get a data provider that has previously been set up

      Type Parameters

      Parameters

      • providerName: string

        Name of the desired data provider

      Returns Promise<T | undefined>

      The data provider with the given name if one exists, undefined otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html index dd5b07ec4c..d500620209 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html @@ -12,4 +12,4 @@ set methods are layered over to facilitate data provider subscriptions.

    Returns Promise<IDisposableDataProvider<"shared/models/data-provider.interface".default<TDataTypes>>>

    The data provider including control over disposing of it. Note that this data provider is a new object distinct from the data provider engine passed in.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_logger_service_.formatLog.html b/papi-dts/functions/_shared_services_logger_service_.formatLog.html index 333a691b7b..9dc1cb0baa 100644 --- a/papi-dts/functions/_shared_services_logger_service_.formatLog.html +++ b/papi-dts/functions/_shared_services_logger_service_.formatLog.html @@ -3,4 +3,4 @@
  • serviceName: string

    Name of the service to show in the log

  • Optional tag: string

    Optional tag at the end of the service name

  • Returns string

    Formatted string of a service message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html b/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html index 0ed052166c..b12cd15809 100644 --- a/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html +++ b/papi-dts/functions/_shared_services_network_connector_factory_.createNetworkConnector.html @@ -1,3 +1,3 @@ createNetworkConnector | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html index 6787bf151f..e6f5a3b6eb 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html +++ b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html @@ -1,3 +1,3 @@ onDidCreateNetworkObject | papi-dts
    • Event that fires when a new object has been created on the network (locally or remotely). The event contains information about the new network object.

      -

      Parameters

      Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html index c52d1dda02..1823705e30 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html +++ b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html @@ -1,2 +1,2 @@ onDidDisposeNetworkObject | papi-dts
    • Event that fires with a network object ID when that object is disposed locally or remotely

      -

      Parameters

      • callback: PlatformEventHandler<string>

      Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html index b47f5b5dc8..4efd8dd827 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html +++ b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html @@ -1,2 +1,2 @@ overrideDispose | papi-dts
    • If dispose already exists on objectToMutate, we will call it in addition to newDispose

      -

      Parameters

      • objectToMutate: IDisposableObject
      • newDispose: UnsubscriberAsync

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html index 5c30332b58..37e77b9668 100644 --- a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html +++ b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html @@ -5,4 +5,4 @@

    WARNING: You cannot emit events with complex types on the network.

    Type Parameters

    Parameters

    Returns PlatformEventEmitter<T>

    Event emitter whose event works between connections

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html index 57fd4d57f7..37072d599d 100644 --- a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html +++ b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns ((...args) => Promise<TReturn>)

    Function to call with arguments of request that performs the request and resolves with the response contents

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index 090957cfbd..a4ccf67f6a 100644 --- a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html +++ b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html @@ -1,4 +1,4 @@ getNetworkEvent | papi-dts
    • Gets the network event with the specified type. Creates the emitter if it does not exist

      Type Parameters

      • T

      Parameters

      • eventType: string

        Unique network event type for coordinating between connections

      Returns PlatformEvent<T>

      Event for the event type that runs the callback provided when the event is emitted

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.initialize.html b/papi-dts/functions/_shared_services_network_service_.initialize.html index 987299c010..dab36410c9 100644 --- a/papi-dts/functions/_shared_services_network_service_.initialize.html +++ b/papi-dts/functions/_shared_services_network_service_.initialize.html @@ -1,2 +1,2 @@ initialize | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html b/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html index 36f0955944..ac4ce7ba6c 100644 --- a/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html +++ b/papi-dts/functions/_shared_services_network_service_.onDidClientConnect.html @@ -1,2 +1,2 @@ onDidClientConnect | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html b/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html index 91c6e50df0..46caf2932c 100644 --- a/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html +++ b/papi-dts/functions/_shared_services_network_service_.onDidClientDisconnect.html @@ -1,2 +1,2 @@ onDidClientDisconnect | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html index 715c587935..8156777112 100644 --- a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html +++ b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html @@ -5,4 +5,4 @@ type the handler has

    Returns Promise<UnsubscriberAsync>

    Promise that resolves if the request successfully registered and unsubscriber function to run to stop the passed-in function from handling requests

    -
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Generated using TypeDoc

    \ No newline at end of file +
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.request.html b/papi-dts/functions/_shared_services_network_service_.request.html index 4326337366..da1dfb020c 100644 --- a/papi-dts/functions/_shared_services_network_service_.request.html +++ b/papi-dts/functions/_shared_services_network_service_.request.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns Promise<TReturn>

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index 84b0a0c563..47297e66ca 100644 --- a/papi-dts/functions/_shared_services_network_service_.shutdown.html +++ b/papi-dts/functions/_shared_services_network_service_.shutdown.html @@ -1,2 +1,2 @@ shutdown | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html index aa75219b5a..70ea3844e6 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html @@ -7,4 +7,4 @@

    Returns Promise<ProjectDataProviders[ProjectType]>

    Data provider with types that are associated with the given project type

    Example

    const pdp = await get('ParatextStandard', 'ProjectID12345');
    pdp.getVerse(new VerseRef('JHN', '1', '1'));
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html index 5ca8c51bb6..e01989e264 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns Promise<Dispose>

    Promise that resolves to a disposable object when the registration operation completes

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html b/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html index aeeba13bbc..2fdf2efd99 100644 --- a/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html +++ b/papi-dts/functions/_shared_services_project_lookup_service_.filterProjectsMetadata.html @@ -1 +1 @@ -filterProjectsMetadata | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +filterProjectsMetadata | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index 4e074ae5e2..c47d701724 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html +++ b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html @@ -1,3 +1,3 @@ getProcessType | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index bcb33b1551..c0f812f9d3 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isClient.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isClient.html @@ -1,3 +1,3 @@ isClient | papi-dts
    • Determine if running on a client process (renderer, extension-host) or on the server.

      Returns boolean

      Returns true if running on a client, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index a67086b2ed..cf5131fa0c 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html @@ -1,3 +1,3 @@ isExtensionHost | papi-dts
    • Determine if running on the extension host

      Returns boolean

      Returns true if running on the extension host, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index fa3721600c..abdb419efd 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html @@ -1,3 +1,3 @@ isRenderer | papi-dts
    • Determine if running on the renderer process

      Returns boolean

      Returns true if running on the renderer, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index ef8220048d..7b0f166a9b 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isServer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isServer.html @@ -1,3 +1,3 @@ isServer | papi-dts
    • Determine if running on the server process (main)

      Returns boolean

      Returns true if running on the server, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html b/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html index aa6ade9951..62f5c22671 100644 --- a/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html +++ b/papi-dts/functions/_shared_utils_util_.createSafeRegisterFn.html @@ -6,4 +6,4 @@
  • initialize: (() => Promise<void>)

    Promise that resolves when the service is finished initializing

  • Returns ((...args) => Promise<UnsubscriberAsync>)

    Safe version of an unsafe function that returns a promise to an UnsubscriberAsync (meaning it will wait to register until the service is initialized)

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html index df4da483ea..1e15539912 100644 --- a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html @@ -1,2 +1,2 @@ deserializeRequestType | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns RequestType

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html index 0a08ff292f..c5201a4d30 100644 --- a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html +++ b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html @@ -1,4 +1,4 @@ getModuleSimilarApiMessage | papi-dts
    • Get a message that says the module import was rejected and to try a similar api if available.

      Parameters

      • moduleName: string

        Name of required module that was rejected

      Returns string

      String that says the import was rejected and a similar api to try

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index 3664610fad..852ba045f6 100644 --- a/papi-dts/functions/_shared_utils_util_.newNonce.html +++ b/papi-dts/functions/_shared_utils_util_.newNonce.html @@ -3,4 +3,4 @@

    WARNING: THIS IS NOT CURRENTLY CRYPTOGRAPHICALLY SECURE! TODO: Make this cryptographically random! Use some polymorphic library that works in all contexts? https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues only works in browser

    -

    Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html index 5170ec99a3..6c0b33cd97 100644 --- a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html @@ -2,4 +2,4 @@

    Parameters

    Returns SerializedRequestType

    Full requestType for use in network calls

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html b/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html index e3ea0725f9..473ca6ab37 100644 --- a/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/functions/getWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ getWebViewDefinitionUpdatableProperties | papi-dts

    Function getWebViewDefinitionUpdatableProperties

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | WebViewDefinitionUpdatableProperties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html b/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html index 1be9d283b9..66e59b7494 100644 --- a/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html +++ b/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html @@ -1 +1 @@ -getWebViewDefinitionUpdatablePropertiesById | papi-dts

    Function getWebViewDefinitionUpdatablePropertiesById

    Generated using TypeDoc

    \ No newline at end of file +getWebViewDefinitionUpdatablePropertiesById | papi-dts

    Function getWebViewDefinitionUpdatablePropertiesById

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index 0207e41e47..bf8f9f307d 100644 --- a/papi-dts/functions/getWebViewState.html +++ b/papi-dts/functions/getWebViewState.html @@ -1,3 +1,3 @@ getWebViewState | papi-dts

    Function getWebViewState

    • Retrieve the value from web view state with the given 'stateKey', if it exists. Otherwise return default value

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • defaultValue: T

      Returns T

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index 15c4d6a3c2..e6976327cd 100644 --- a/papi-dts/functions/resetWebViewState.html +++ b/papi-dts/functions/resetWebViewState.html @@ -1,2 +1,2 @@ resetWebViewState | papi-dts

    Function resetWebViewState

    • Remove the value for a given key in the web view state

      -

      Parameters

      • stateKey: string

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 257ba3afb6..032a7b63a2 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    Function setWebViewState

    • Set the value for a given key in the web view state.

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index 3ceb2087bb..825bd78b43 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -5,4 +5,4 @@

    @example

    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -

    Parameters

    Returns boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index 9e62ed25b0..d2e6b18367 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    Function updateWebViewDefinitionById

    Generated using TypeDoc

    \ No newline at end of file +updateWebViewDefinitionById | papi-dts

    Function updateWebViewDefinitionById

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index 7e1a972bf8..9d6efe4342 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -24,4 +24,4 @@

    @example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -

    Type Parameters

    Parameters

    Returns [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index 5b874704f0..ae658ff072 100644 --- a/papi-dts/functions/webViewComponent.html +++ b/papi-dts/functions/webViewComponent.html @@ -1,6 +1,6 @@ webViewComponent | papi-dts

    Function webViewComponent

    • A function that each React WebView extension must provide for Paranext to display it. Only used in WebView iframes.

      -

      Parameters

      Returns ReactNode

    Properties

    Parameters

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html index ae9d467434..3b761fe4d7 100644 --- a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html +++ b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html @@ -1,5 +1,5 @@ IExtension | papi-dts

    Interface for all extensions to implement

    -
    interface IExtension {
        activate: ((context) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

    interface IExtension {
        activate: ((context) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

    activate: ((context) => Promise<void>)

    Sets up this extension! Runs when paranext wants this extension to activate. For example, activate() should register commands for this extension

    @@ -7,7 +7,7 @@ activate() should register commands for this extension

    Parameters

    Returns Promise<void>

    Param: context

    Data and utilities that are specific to this particular extension

    -
    deactivate?: UnsubscriberAsync

    Deactivate anything in this extension that is not covered by the registrations in the context +

    deactivate?: UnsubscriberAsync

    Deactivate anything in this extension that is not covered by the registrations in the context object given to activate().

    Returns

    Promise that resolves to true if successfully deactivated

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html index 491f8cc3f8..29da1d0a46 100644 --- a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html +++ b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html @@ -1,4 +1,4 @@ -ExtensionStorageService | papi-dts
    interface ExtensionStorageService {
        deleteUserData: ((token, key) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>);
        readUserData: ((token, key) => Promise<string>);
        writeUserData: ((token, key, data) => Promise<void>);
    }

    Properties

    deleteUserData +ExtensionStorageService | papi-dts
    interface ExtensionStorageService {
        deleteUserData: ((token, key) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>);
        readUserData: ((token, key) => Promise<string>);
        writeUserData: ((token, key, data) => Promise<void>);
    }

    Properties

    Parameters

    • token: ExecutionToken

      ExecutionToken provided to the extension when activate() was called

    • key: string

      Unique identifier of the data

    Returns Promise<void>

    Promise that will resolve if the data is deleted successfully

    -
    readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>
      • Read a binary file from the the extension's installation directory

        +
    readBinaryFileFromInstallDirectory: ((token, fileName) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>
      • Read a binary file from the the extension's installation directory

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<Buffer>

        Promise for a Buffer with the contents of the file

        -
    readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>
      • Read a text file from the the extension's installation directory

        +
    readTextFileFromInstallDirectory: ((token, fileName) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>
      • Read a text file from the the extension's installation directory

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<string>

        Promise for a string with the contents of the file

        -
    readUserData: ((token, key) => Promise<string>)

    Type declaration

      • (token, key): Promise<string>
      • Read data specific to the user (as identified by the OS) and extension (as identified by the +

    readUserData: ((token, key) => Promise<string>)

    Type declaration

      • (token, key): Promise<string>
      • Read data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        Returns Promise<string>

        Promise for a string containing the data

        -
    writeUserData: ((token, key, data) => Promise<void>)

    Type declaration

      • (token, key, data): Promise<void>
      • Write data specific to the user (as identified by the OS) and extension (as identified by the +

    writeUserData: ((token, key, data) => Promise<void>)

    Type declaration

      • (token, key, data): Promise<void>
      • Write data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        • data: string

          Data to be written

        Returns Promise<void>

        Promise that will resolve if the data is written successfully

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html index ef13578611..fedf33aa5b 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -6,7 +6,7 @@ following to its .d.ts file:

    Example

    declare module 'papi-shared-types' {
    export interface CommandHandlers {
    'myExtension.myCommand1': (foo: string, bar: number) => string;
    'myExtension.myCommand2': (foo: string) => Promise<void>;
    }
    }
    -
    interface CommandHandlers {
        platform.quit: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums) => number);
        test.echo: ((message) => string);
        test.echoExtensionHost: ((message) => Promise<string>);
        test.echoRenderer: ((message) => Promise<string>);
        test.throwError: ((message) => void);
        test.throwErrorExtensionHost: ((message) => void);
    }

    Properties

    interface CommandHandlers {
        platform.quit: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums) => number);
        test.echo: ((message) => string);
        test.echoExtensionHost: ((message) => Promise<string>);
        test.echoRenderer: ((message) => Promise<string>);
        test.throwError: ((message) => void);
        test.throwErrorExtensionHost: ((message) => void);
    }

    Properties

    platform.quit: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    platform.restartExtensionHost: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    test.addMany: ((...nums) => number)

    Type declaration

      • (...nums): number
      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo: ((message) => string)

    Type declaration

      • (message): string
      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.echoRenderer: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.quit: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    platform.restartExtensionHost: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Returns Promise<void>

    test.addMany: ((...nums) => number)

    Type declaration

      • (...nums): number
      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo: ((message) => string)

    Type declaration

      • (message): string
      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.echoRenderer: ((message) => Promise<string>)

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost: ((message) => void)

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html index c639ad8060..1b968e3ada 100644 --- a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html @@ -10,6 +10,6 @@ 'helloSomeone.people' data provider types):

    Example

    declare module 'papi-shared-types' {
    export type PeopleDataTypes = {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    };

    export type PeopleDataMethods = {
    deletePerson(name: string): Promise<boolean>;
    testRandomMethod(things: string): Promise<string>;
    };

    export type PeopleDataProvider = IDataProvider<PeopleDataTypes> & PeopleDataMethods;

    export interface DataProviders {
    'helloSomeone.people': PeopleDataProvider;
    }
    }
    -
    interface DataProviders {
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>;
        platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>;
    }

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html index 5685eac4f4..c20bd9ce94 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html @@ -18,6 +18,6 @@ are adding a Project Data Provider type for the MyExtensionProjectTypeName projectType):

    Example

    declare module 'papi-shared-types' {
    export type MyProjectDataTypes = MandatoryProjectDataTypes & {
    MyProjectData: DataProviderDataType<string, string, string>;
    };

    export interface ProjectDataProviders {
    MyExtensionProjectTypeName: IDataProvider<MyProjectDataTypes>;
    }
    }
    -
    interface ProjectDataProviders {
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html index 41562fc50d..f4ce2ae302 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -9,13 +9,13 @@ myExtension.highlightColor project setting):

    Example

    declare module 'papi-shared-types' {
    export interface ProjectSettingTypes {
    'myExtension.highlightColor': string | { r: number; g: number; b: number };
    }
    }
    -
    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.language: string;
    }

    Properties

    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.language: string;
    }

    Properties

    platform.fullName: string

    Localized full name of the project. This will be displayed directly in the UI.

    Example

    'World English Bible'
     
    -
    platform.language: string

    Localized name of the language in which this project is written. This will be displayed +

    platform.language: string

    Localized name of the language in which this project is written. This will be displayed directly in the UI.

    Example

    'English'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectStorageInterpreters.html b/papi-dts/interfaces/_papi_shared_types_.ProjectStorageInterpreters.html index dfc149532b..de2f74fc8e 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectStorageInterpreters.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectStorageInterpreters.html @@ -16,6 +16,6 @@ adding a Project Storage Interpreter type for the MyExtensionProjectTypeName projectType):

    Example

    declare module 'papi-shared-types' {
    export type MyProjectStorageDataType = MandatoryProjectStorageDataTypes & {
    ProjectData: DataProviderDataType<
    { projectId: string; section: number },
    string | undefined,
    string
    >;
    };

    export interface ProjectStorageInterpreters {
    MyExtensionProjectTypeName: IProjectStorageInterpreter<MyProjectStorageDataType>;
    }
    }
    -
    interface ProjectStorageInterpreters {
        platform.notesOnly: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>;
        platform.placeholder: IProjectStorageInterpreter<DefaultProjectStorageDataTypes>;
    }

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 57483704b9..034864ded1 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -8,6 +8,6 @@ myExtension.highlightColor setting):

    Example

    declare module 'papi-shared-types' {
    export interface SettingTypes {
    'myExtension.highlightColor': string | { r: number; g: number; b: number };
    }
    }
    -
    interface SettingTypes {
        platform.interfaceLanguage: string[];
        platform.verseRef: ScriptureReference;
    }

    Properties

    interface SettingTypes {
        platform.interfaceLanguage: string[];
        platform.verseRef: ScriptureReference;
    }

    Properties

    platform.interfaceLanguage: string[]
    platform.verseRef: ScriptureReference

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.interfaceLanguage: string[]
    platform.verseRef: ScriptureReference

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html index c4bcfecd2c..135e98d784 100644 --- a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html +++ b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html @@ -1,6 +1,6 @@ DialogTypes | papi-dts

    Mapped type for dialog functions to use in getting various types for dialogs

    Keys should be dialog names, and values should be DialogDataTypes

    If you add a dialog here, you must also add it on DIALOGS

    -

    Properties

    Properties

    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html index d6c378310c..4ff016decf 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html @@ -1,6 +1,6 @@ FloatLayout | papi-dts

    Information about a floating window

    -
    interface FloatLayout {
        floatSize?: FloatSize;
        position?: FloatPosition;
        type: "float";
    }

    Properties

    interface FloatLayout {
        floatSize?: FloatSize;
        position?: FloatPosition;
        type: "float";
    }

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -
    type: "float"

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +
    type: "float"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html index d7af8f07e1..8b8984e7c1 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html @@ -1,6 +1,6 @@ PanelLayout | papi-dts

    Information about a panel

    -
    interface PanelLayout {
        direction?: PanelDirection;
        targetTabId?: string;
        type: "panel";
    }

    Properties

    interface PanelLayout {
        direction?: PanelDirection;
        targetTabId?: string;
        type: "panel";
    }

    Properties

    direction?: PanelDirection
    targetTabId?: string

    If undefined, it will add in the direction relative to the previously added tab.

    -
    type: "panel"

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction?: PanelDirection
    targetTabId?: string

    If undefined, it will add in the direction relative to the previously added tab.

    +
    type: "panel"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html index 9d68ceec18..2417685dac 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html @@ -1,3 +1,3 @@ TabLayout | papi-dts

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type: "tab"

    Generated using TypeDoc

    \ No newline at end of file +
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type: "tab"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html index 33bbb0a82a..5b31332b87 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngineFactory.html @@ -8,7 +8,7 @@

    Project Data Provider Engine Factories create Project Data Provider Engines for a specific projectType. For each project available, a new instance of a PDP with that project's projectType is created by the Project Data Provider Factory with that project's projectType.

    -
    interface IProjectDataProviderEngineFactory<ProjectType> {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    interface IProjectDataProviderEngineFactory<ProjectType> {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    • Create a IProjectDataProviderEngine for the project requested so the papi can create an IProjectDataProvider for the project. This project will have the same projectType as this Project Data Provider Engine Factory

      @@ -16,4 +16,4 @@
    • projectStorageInterpreterId: string

      Id of the IProjectStorageInterpreter that the IProjectDataProviderEngine should use to retrieve project data

    Returns ProjectDataProviderEngineTypes[ProjectType]

    A IProjectDataProviderEngine for the project passed in

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html index 5f3fc00620..c4313f4b0d 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html @@ -2,10 +2,10 @@ the papi. These are created internally within the platform to layer over TypeScript-extension-provided IProjectDataProviderEngineFactory or are created by independent processes on the papi.

    -
    interface default {
        dispose: UnsubscriberAsync;
        getProjectDataProviderId(projectId, projectStorageInterpreterId): Promise<string>;
    }

    Hierarchy

    Properties

    interface default {
        dispose: UnsubscriberAsync;
        getProjectDataProviderId(projectId, projectStorageInterpreterId): Promise<string>;
    }

    Hierarchy

    • Dispose
      • default

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

    • Returns the registered network object name of a PDP for the given project ID and PSI. Called by +

    Methods

    • Returns the registered network object name of a PDP for the given project ID and PSI. Called by the platform when someone uses the project data provider service to access a project's data.

      Parameters

      • projectId: string

        Id of the project for which to return a project data provider.

      • projectStorageInterpreterId: string

        Id of the project storage interpreter that corresponds to @@ -14,4 +14,4 @@ project id. It should return the same project data provider for the same combination of parameters throughout one session (in other words, in general, there should just be one project data provider for one project id).

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html index 1612ddb2e3..d595347a9a 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html @@ -1,10 +1,10 @@ DisposableWebViewProvider | papi-dts

    An object of this type is returned from networkObjectService.set.

    See

    networkObjectService

    -
    interface DisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface DisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    Methods

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html index 447513d7d8..83b6c04dc8 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html @@ -1,10 +1,10 @@ IWebViewProvider | papi-dts

    An object of this type is passed into networkObjectService.set.

    See

    networkObjectService

    -
    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html index 127c43e69e..32ca05b336 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.WebViewProvider.html @@ -5,11 +5,11 @@ call that method. This is because we don't want users of network objects to dispose of them. Only the caller of networkObjectService.set should be able to dispose of the network object.

    See

    networkObjectService

    -
    interface WebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface WebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebView, getWebViewOptions): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    Methods

    Properties

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions
  • Returns Promise<undefined | WebViewDefinition>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html index 0c554a72a3..19844ea8cd 100644 --- a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html +++ b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html @@ -1,4 +1,4 @@ -DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method): void;
                (target, member): void;
            };
            ignore: {
                (method): void;
                (target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine +DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method): void;
                (target, member): void;
            };
            ignore: {
                (method): void;
                (target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine decorators get hasKnown @@ -7,7 +7,7 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

    See

    IDataProviderEngine for more information on extending this class.

    -
    decorators: {
        doNotNotify: {
            (method): void;
            (target, member): void;
        };
        ignore: {
            (method): void;
            (target, member): void;
        };
    }

    A collection of decorators to be used with the data provider service

    +
    decorators: {
        doNotNotify: {
            (method): void;
            (target, member): void;
        };
        ignore: {
            (method): void;
            (target, member): void;
        };
    }

    A collection of decorators to be used with the data provider service

    Type declaration

    • doNotNotify: {
          (method): void;
          (target, member): void;
      }

      Decorator function that marks a data provider engine set<data_type> method not to automatically emit an update and notify subscribers of a change to the data. papi will still consider the set<data_type> method to be a data type method, but it will not layer over it to emit updates.

      @@ -80,19 +80,19 @@

      Example: Call this function signature on an object's method:

      WARNING: Do not copy and paste this example. The @ symbol does not render correctly in JSDoc
       code blocks, so a different unicode character was used. Please use a normal @ when using a
       decorator.

      -
    get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>)

    Get a data provider that has previously been set up

    +
    get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>)

    Get a data provider that has previously been set up

    Type declaration

      • <DataProviderName>(providerName): Promise<DataProviders[DataProviderName] | undefined>
      • Get a data provider that has previously been set up

        Type Parameters

        • DataProviderName extends keyof DataProviders

        Parameters

        Returns Promise<DataProviders[DataProviderName] | undefined>

        The data provider with the given name if one exists, undefined otherwise

    Param: providerName

    Name of the desired data provider

    Returns

    The data provider with the given name if one exists, undefined otherwise

    -
    hasKnown: ((providerName) => boolean)

    Indicate if we are aware of an existing data provider with the given name. If a data provider +

    hasKnown: ((providerName) => boolean)

    Indicate if we are aware of an existing data provider with the given name. If a data provider with the given name is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

    Type declaration

      • (providerName): boolean
      • Indicate if we are aware of an existing data provider with the given name. If a data provider with the given name is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

        -

        Parameters

        • providerName: string

        Returns boolean

    registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>)

    Creates a data provider to be shared on the network layering over the provided data provider +

    Parameters

    • providerName: string

    Returns boolean

    registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>)

    Creates a data provider to be shared on the network layering over the provided data provider engine.

    Type declaration

      • <DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?): Promise<DisposableDataProviders[DataProviderName]>
      • Creates a data provider to be shared on the network layering over the provided data provider engine.

        @@ -120,4 +120,4 @@

        Param: dataProviderAttributes

        Optional object that will be sent in a set methods are layered over to facilitate data provider subscriptions.

        Returns

        The data provider including control over disposing of it. Note that this data provider is a new object distinct from the data provider engine passed in.

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html index ae4721a377..c6c75a45f4 100644 --- a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html +++ b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html @@ -1,11 +1,11 @@ DialogService | papi-dts

    Prompt the user for responses with dialogs

    -
    interface DialogService {
        selectProject(options?): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType, options?): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    interface DialogService {
        selectProject(options?): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType, options?): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    • Shows a select project dialog to the user and prompts the user to select a dialog

      Parameters

      Returns Promise<undefined | string>

      Returns the user's selected project id or undefined if the user cancels

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index 73c2a5c98b..e60ffe7d11 100644 --- a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html +++ b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html @@ -1,3 +1,3 @@ -InternetService | papi-dts
    interface InternetService {
        fetch: {
            (input, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
    }

    Properties

    fetch +InternetService | papi-dts
    interface InternetService {
        fetch: {
            (input, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
    }

    Properties

    Properties

    fetch: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    }

    Type declaration

      • (input, init?): Promise<Response>
      • Parameters

        • input: RequestInfo | URL
        • Optional init: RequestInit

        Returns Promise<Response>

      • (input, init?): Promise<Response>
      • Parameters

        • input: string | Request | URL
        • Optional init: RequestInit

        Returns Promise<Response>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • (input, init?): Promise<Response>
  • Parameters

    • input: string | Request | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html b/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html index 6fa3f090fb..198042f87b 100644 --- a/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html +++ b/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html @@ -1,7 +1,7 @@ default | papi-dts

    Interface that defines the network connection functionality the server and the client must implement. Used by NetworkConnectorFactory to supply the right kind of NetworkConnector to ConnectionService

    -
    interface default {
        connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
            clientId: number;
        }>>);
        connectionStatus: ConnectionStatus;
        connectorInfo: Readonly<{
            clientId: number;
        }>;
        disconnect: (() => void);
        emitEventOnNetwork: (<T>(eventType, event) => Promise<void>);
        notifyClientConnected: (() => Promise<void>);
        request: InternalRequestHandler;
    }

    Implemented by

    Properties

    interface default {
        connect: ((localRequestHandler, requestRouter, localEventHandler, networkConnectorEventHandlers) => Promise<Readonly<{
            clientId: number;
        }>>);
        connectionStatus: ConnectionStatus;
        connectorInfo: Readonly<{
            clientId: number;
        }>;
        disconnect: (() => void);
        emitEventOnNetwork: (<T>(eventType, event) => Promise<void>);
        notifyClientConnected: (() => Promise<void>);
        request: InternalRequestHandler;
    }

    Implemented by

    Properties

    connect connectionStatus connectorInfo disconnect @@ -40,10 +40,10 @@

    Param: localEventHandler

    Function that handles events from the server

    Param: networkConnectorEventHandlers

    Functions that run when network connector events occur like when clients are disconnected

    Returns

    Promise that resolves with connector info when finished connecting

    -
    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to +

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -
    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Disconnects from the connection:

    +
    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number
    disconnect: (() => void)

    Disconnects from the connection:

    • On Client: disconnects from the server
    • On Server: disconnects from clients and closes its connection endpoint
    • @@ -53,7 +53,7 @@

      Returns

      Promise that resolves with connector info when finished conne

    • On Client: disconnects from the server
    • On Server: disconnects from clients and closes its connection endpoint
    -

    Returns void

    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

    Returns void

    emitEventOnNetwork: (<T>(eventType, event) => Promise<void>)

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Type declaration

      • <T>(eventType, event): Promise<void>
      • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

        @@ -61,14 +61,14 @@

        Returns

        Promise that resolves with connector info when finished conne

      • event: InternalEvent<T>

        Event to emit on the network

    Returns Promise<void>

    Param: eventType

    Unique network event type for coordinating between processes

    Param: event

    Event to emit on the network

    -
    notifyClientConnected: (() => Promise<void>)

    Notify the server that this client has received its connectorInfo and is ready to go.

    +
    notifyClientConnected: (() => Promise<void>)

    Notify the server that this client has received its connectorInfo and is ready to go.

    MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

    TODO: Is this necessary?

    Type declaration

      • (): Promise<void>
      • Notify the server that this client has received its connectorInfo and is ready to go.

        MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

        TODO: Is this necessary?

        -

        Returns Promise<void>

    Send a request to the server/a client and resolve after receiving a response

    +

    Returns Promise<void>

    request: InternalRequestHandler

    Send a request to the server/a client and resolve after receiving a response

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index 1b140a3fd2..8778c45b6a 100644 --- a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html +++ b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html @@ -1,8 +1,8 @@ -NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>)

    Get details about all available network objects

    Type declaration

    Returns

    Object whose keys are the names of the network objects and whose values are the NetworkObjectDetails for each network object

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html index 997827402b..503e74dc1f 100644 --- a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html +++ b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusServiceType.html @@ -1,5 +1,5 @@ NetworkObjectStatusServiceType | papi-dts

    Provides functions related to the set of available network objects

    -
    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((id, timeoutInMS?) => Promise<NetworkObjectDetails>);
    }

    Hierarchy (view full)

    Properties

    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((id, timeoutInMS?) => Promise<NetworkObjectDetails>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>)

    Get details about all available network objects

    Type declaration

    Returns

    Object whose keys are the names of the network objects and whose values are the NetworkObjectDetails for each network object

    -
    waitForNetworkObject: ((id, timeoutInMS?) => Promise<NetworkObjectDetails>)

    Get a promise that resolves when a network object is registered or rejects if a timeout is hit

    +
    waitForNetworkObject: ((id, timeoutInMS?) => Promise<NetworkObjectDetails>)

    Get a promise that resolves when a network object is registered or rejects if a timeout is hit

    Type declaration

      • (id, timeoutInMS?): Promise<NetworkObjectDetails>
      • Get a promise that resolves when a network object is registered or rejects if a timeout is hit

        Parameters

        • id: string
        • Optional timeoutInMS: number

        Returns Promise<NetworkObjectDetails>

        Promise that either resolves to the NetworkObjectDetails for a network object once the network object is registered, or rejects if a timeout is provided and the timeout is @@ -15,4 +15,4 @@

    Returns

    Promise that either resolves to the NetworkObjectDetails for a network object once the network object is registered, or rejects if a timeout is provided and the timeout is reached before the network object is registered

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index 44b56b17dc..6513735a45 100644 --- a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html +++ b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html @@ -1,4 +1,4 @@ -PapiNetworkService | papi-dts
    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType) => PlatformEvent<T>);
        onDidClientConnect: PlatformEvent<ClientConnectEvent>;
        onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>;
    }

    Properties

    createNetworkEventEmitter +PapiNetworkService | papi-dts
    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType) => PlatformEvent<T>);
        onDidClientConnect: PlatformEvent<ClientConnectEvent>;
        onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>;
    }

    Properties

    createNetworkEventEmitter getNetworkEvent onDidClientConnect onDidClientDisconnect @@ -9,7 +9,7 @@

    WARNING: You cannot emit events with complex types on the network.

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between connections

    Returns PlatformEventEmitter<T>

    Event emitter whose event works between connections

    -
    getNetworkEvent: (<T>(eventType) => PlatformEvent<T>)

    Type declaration

      • <T>(eventType): PlatformEvent<T>
      • Gets the network event with the specified type. Creates the emitter if it does not exist

        +
    getNetworkEvent: (<T>(eventType) => PlatformEvent<T>)

    Type declaration

      • <T>(eventType): PlatformEvent<T>
      • Gets the network event with the specified type. Creates the emitter if it does not exist

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between connections

        Returns PlatformEvent<T>

        Event for the event type that runs the callback provided when the event is emitted

        -
    onDidClientConnect: PlatformEvent<ClientConnectEvent>
    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>

    Generated using TypeDoc

    \ No newline at end of file +
    onDidClientConnect: PlatformEvent<ClientConnectEvent>
    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html index c4a93c0753..dffe9f7149 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
        registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>)

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProviders[ProjectType]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectType: ProjectType

          Indicates what you expect the projectType to be for the project with the @@ -9,9 +9,9 @@

        Returns Promise<ProjectDataProviders[ProjectType]>

        Data provider with types that are associated with the given project type

        Example

        const pdp = await get('ParatextStandard', 'ProjectID12345');
        pdp.getVerse(new VerseRef('JHN', '1', '1'));
        -
    registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>)

    Type declaration

      • <ProjectType>(projectType, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine. There must not be an +

    registerProjectDataProviderEngineFactory: (<ProjectType>(projectType, pdpEngineFactory) => Promise<Dispose>)

    Type declaration

      • <ProjectType>(projectType, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine. There must not be an existing factory already that handles the same project type or this operation will fail.

        Type Parameters

        Parameters

        Returns Promise<Dispose>

        Promise that resolves to a disposable object when the registration operation completes

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html index 4bff8a7c1c..215ad264a4 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>);
    }

    Properties

    Properties

    get: (<ProjectType>(projectType, projectId) => Promise<ProjectDataProviders[ProjectType]>)

    Type declaration

      • <ProjectType>(projectType, projectId): Promise<ProjectDataProviders[ProjectType]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectType: ProjectType

          Indicates what you expect the projectType to be for the project with the specified id. The TypeScript type for the returned project data provider will have the project @@ -8,4 +8,4 @@

        Returns Promise<ProjectDataProviders[ProjectType]>

        Data provider with types that are associated with the given project type

        Example

        const pdp = await get('ParatextStandard', 'ProjectID12345');
        pdp.getVerse(new VerseRef('JHN', '1', '1'));
        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html index 9bdba90cc1..f88ed80d9e 100644 --- a/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html @@ -1,14 +1,14 @@ ProjectLookupServiceType | papi-dts

    Provides metadata for projects known by the platform

    -
    interface ProjectLookupServiceType {
        getMetadataForAllProjects: (() => Promise<ProjectMetadata[]>);
        getMetadataForProject: ((projectId) => Promise<ProjectMetadata>);
    }

    Properties

    interface ProjectLookupServiceType {
        getMetadataForAllProjects: (() => Promise<ProjectMetadata[]>);
        getMetadataForProject: ((projectId) => Promise<ProjectMetadata>);
    }

    Properties

    getMetadataForAllProjects: (() => Promise<ProjectMetadata[]>)

    Provide metadata for all projects found on the local system

    Type declaration

      • (): Promise<ProjectMetadata[]>
      • Provide metadata for all projects found on the local system

        Returns Promise<ProjectMetadata[]>

        ProjectMetadata for all projects stored on the local system

    Returns

    ProjectMetadata for all projects stored on the local system

    -
    getMetadataForProject: ((projectId) => Promise<ProjectMetadata>)

    Look up metadata for a specific project ID

    +
    getMetadataForProject: ((projectId) => Promise<ProjectMetadata>)

    Look up metadata for a specific project ID

    Type declaration

      • (projectId): Promise<ProjectMetadata>
      • Look up metadata for a specific project ID

        Parameters

        • projectId: string

          ID of the project to load

        Returns Promise<ProjectMetadata>

        ProjectMetadata from the 'meta.json' file for the given project

    Param: projectId

    ID of the project to load

    Returns

    ProjectMetadata from the 'meta.json' file for the given project

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html index 9085eb0877..8167169195 100644 --- a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html +++ b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html @@ -1,6 +1,6 @@ IProjectSettingsService | papi-dts

    Provides utility functions that project storage interpreters should call when handling project settings

    -
    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key, projectType): Promise<ProjectSettingTypes[ProjectSettingName]>;
        isValid<ProjectSettingName>(key, newValue, currentValue, projectType, allChanges?): Promise<boolean>;
        registerValidator<ProjectSettingName>(key, validatorCallback): Promise<UnsubscriberAsync>;
    }

    Methods

    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key, projectType): Promise<ProjectSettingTypes[ProjectSettingName]>;
        isValid<ProjectSettingName>(key, newValue, currentValue, projectType, allChanges?): Promise<boolean>;
        registerValidator<ProjectSettingName>(key, validatorCallback): Promise<UnsubscriberAsync>;
    }

    Methods

    Returns Promise<ProjectSettingTypes[ProjectSettingName]>

    The default value for the setting if a default value is registered

    Throws

    If a default value is not registered for the setting

    -
    • Calls registered project settings validators to determine whether or not a project setting +

    • Calls registered project settings validators to determine whether or not a project setting change is valid.

      Every Project Storage Interpreter must run this function when it receives a request to set a project setting before changing the value of the setting.

      @@ -22,7 +22,7 @@
    • projectType: keyof ProjectDataProviders

      The projectType for the project whose setting is being changed

    • Optional allChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html index 0b6b0d19ca..179701c3bc 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html @@ -1,8 +1,8 @@ -PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    register +PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    Properties

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

          Object to register as a webView provider including control over disposing of it.

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html index 390fc62795..b58f44ab40 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html @@ -1,19 +1,19 @@ -WebViewProviderService | papi-dts
    interface WebViewProviderService {
        get: ((webViewType) => Promise<WebViewProvider | undefined>);
        hasKnown: ((webViewType) => boolean);
        initialize: (() => Promise<void>);
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    get +WebViewProviderService | papi-dts
    interface WebViewProviderService {
        get: ((webViewType) => Promise<WebViewProvider | undefined>);
        hasKnown: ((webViewType) => boolean);
        initialize: (() => Promise<void>);
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    get: ((webViewType) => Promise<WebViewProvider | undefined>)

    Type declaration

      • (webViewType): Promise<WebViewProvider | undefined>
      • Get a web view provider that has previously been set up

        Parameters

        • webViewType: string

          Type of webview provider to get

        Returns Promise<WebViewProvider | undefined>

        Web view provider with the given name if one exists, undefined otherwise

        -
    hasKnown: ((webViewType) => boolean)

    Type declaration

      • (webViewType): boolean
      • Indicate if we are aware of an existing web view provider with the given type. If a web view +

    hasKnown: ((webViewType) => boolean)

    Type declaration

      • (webViewType): boolean
      • Indicate if we are aware of an existing web view provider with the given type. If a web view provider with the given type is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

        Parameters

        • webViewType: string

          Type of webView to check for

          -

        Returns boolean

    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        -

        Returns Promise<void>

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        +

    Returns boolean

    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        +

        Returns Promise<void>

    register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<DisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

          Object to register as a webView provider including control over disposing of it.

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html index 4091835f41..047f722f8e 100644 --- a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html +++ b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html @@ -1,7 +1,7 @@ WebViewServiceType | papi-dts

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
    interface WebViewServiceType {
        getWebView: ((webViewType, layout?, options?) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<AddWebViewEvent>;
    }

    Properties

    interface WebViewServiceType {
        getWebView: ((webViewType, layout?, options?) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<AddWebViewEvent>;
    }

    Properties

    getWebView: ((webViewType, layout?, options?) => Promise<undefined | string>)

    Creates a new web view or gets an existing one depending on if you request an existing one and if the web view provider decides to give that existing one to you (it is up to the provider).

    @@ -21,5 +21,5 @@

    Param: options

    Options that affect what this function does. For examp

    Returns

    Promise that resolves to the ID of the webview we got or undefined if the provider did not create a WebView for this request.

    Throws

    If something went wrong like the provider for the webViewType was not found

    -
    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -

    Generated using TypeDoc

    \ No newline at end of file +
    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index 95e80c91f1..5e2816e138 100644 --- a/papi-dts/modules/__papi_backend_.html +++ b/papi-dts/modules/__papi_backend_.html @@ -1,4 +1,4 @@ -"@papi/backend" | papi-dts

    Namespace "@papi/backend"

    Index

    Variables

    DataProviderEngine +"@papi/backend" | papi-dts

    Namespace "@papi/backend"

    Index

    Variables

    DataProviderEngine ProjectDataProviderEngine commands dataProviders diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 144d137c5f..33d5c6325e 100644 --- a/papi-dts/modules/__papi_core_.html +++ b/papi-dts/modules/__papi_core_.html @@ -1,4 +1,4 @@ -"@papi/core" | papi-dts

    Namespace "@papi/core"

    References

    DataProviderDataType +"@papi/core" | papi-dts

    Namespace "@papi/core"

    References

    DataProviderDataType DataProviderSubscriberOptions DataProviderUpdateInstructions DialogOptions diff --git a/papi-dts/modules/__papi_frontend_.html b/papi-dts/modules/__papi_frontend_.html index de5abe1f47..6b2a8680fa 100644 --- a/papi-dts/modules/__papi_frontend_.html +++ b/papi-dts/modules/__papi_frontend_.html @@ -1,4 +1,4 @@ -"@papi/frontend" | papi-dts

    Namespace "@papi/frontend"

    Index

    Type Aliases

    Papi +"@papi/frontend" | papi-dts

    Namespace "@papi/frontend"

    Index

    Type Aliases

    Variables

    WebSocket XMLHttpRequest commands diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index 6536149af0..c4d3a051e9 100644 --- a/papi-dts/modules/__papi_frontend_react_.html +++ b/papi-dts/modules/__papi_frontend_react_.html @@ -1,4 +1,4 @@ -"@papi/frontend/react" | papi-dts

    Namespace "@papi/frontend/react"

    References

    useData +"@papi/frontend/react" | papi-dts

    Namespace "@papi/frontend/react"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_client_services_client_network_connector_service_.html b/papi-dts/modules/_client_services_client_network_connector_service_.html index d47aca2384..33e2e16039 100644 --- a/papi-dts/modules/_client_services_client_network_connector_service_.html +++ b/papi-dts/modules/_client_services_client_network_connector_service_.html @@ -1,2 +1,2 @@ -"client/services/client-network-connector.service" | papi-dts

    Namespace "client/services/client-network-connector.service"

    Index

    Classes

    default +"client/services/client-network-connector.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_client_services_web_socket_factory_.html b/papi-dts/modules/_client_services_web_socket_factory_.html index 8a8a714965..1d7e60fabf 100644 --- a/papi-dts/modules/_client_services_web_socket_factory_.html +++ b/papi-dts/modules/_client_services_web_socket_factory_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.factory" | papi-dts

    Namespace "client/services/web-socket.factory"

    Index

    Functions

    createWebSocket +"client/services/web-socket.factory" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_client_services_web_socket_interface_.html b/papi-dts/modules/_client_services_web_socket_interface_.html index 873d6f158a..30c69e6238 100644 --- a/papi-dts/modules/_client_services_web_socket_interface_.html +++ b/papi-dts/modules/_client_services_web_socket_interface_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.interface" | papi-dts

    Namespace "client/services/web-socket.interface"

    Index

    Type Aliases

    IWebSocket +"client/services/web-socket.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html index 5981351b77..770bc3b201 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-activation-context.model" | papi-dts

    Namespace "extension-host/extension-types/extension-activation-context.model"

    Index

    Type Aliases

    ExecutionActivationContext +"extension-host/extension-types/extension-activation-context.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html index 10cf7ac61a..2a454eb66f 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension.interface" | papi-dts

    Namespace "extension-host/extension-types/extension.interface"

    Index

    Interfaces

    IExtension +"extension-host/extension-types/extension.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html index 495c1311c9..2dbbaa3ea8 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-manifest.model" | papi-dts

    Namespace "extension-host/extension-types/extension-manifest.model"

    Index

    Type Aliases

    ExtensionManifest +"extension-host/extension-types/extension-manifest.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html index bdb7958525..e6de348c77 100644 --- a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html +++ b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html @@ -1,3 +1,3 @@ -"extension-host/services/extension-host-web-socket.model" | papi-dts

    Namespace "extension-host/services/extension-host-web-socket.model"

    Index

    Namespaces

    default +"extension-host/services/extension-host-web-socket.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_extension_host_services_extension_storage_service_.html b/papi-dts/modules/_extension_host_services_extension_storage_service_.html index 7772eb4042..8276a64a2a 100644 --- a/papi-dts/modules/_extension_host_services_extension_storage_service_.html +++ b/papi-dts/modules/_extension_host_services_extension_storage_service_.html @@ -1,4 +1,4 @@ -"extension-host/services/extension-storage.service" | papi-dts

    Namespace "extension-host/services/extension-storage.service"

    Index

    Interfaces

    ExtensionStorageService +"extension-host/services/extension-storage.service" | papi-dts

    Namespace "extension-host/services/extension-storage.service"

    Index

    Interfaces

    Variables

    Functions

    buildExtensionPathFromName setExtensionUris diff --git a/papi-dts/modules/_main_services_server_network_connector_service_.html b/papi-dts/modules/_main_services_server_network_connector_service_.html index f94488a4e3..26a0495b7c 100644 --- a/papi-dts/modules/_main_services_server_network_connector_service_.html +++ b/papi-dts/modules/_main_services_server_network_connector_service_.html @@ -1,2 +1,2 @@ -"main/services/server-network-connector.service" | papi-dts

    Namespace "main/services/server-network-connector.service"

    Index

    Classes

    default +"main/services/server-network-connector.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_models_execution_token_model_.html b/papi-dts/modules/_node_models_execution_token_model_.html index 6d27047648..08052215f1 100644 --- a/papi-dts/modules/_node_models_execution_token_model_.html +++ b/papi-dts/modules/_node_models_execution_token_model_.html @@ -1,3 +1,3 @@ -"node/models/execution-token.model" | papi-dts

    Namespace "node/models/execution-token.model"

    Index

    Classes

    ExecutionToken +"node/models/execution-token.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_services_execution_token_service_.html b/papi-dts/modules/_node_services_execution_token_service_.html index a4ef905e20..0995217f1f 100644 --- a/papi-dts/modules/_node_services_execution_token_service_.html +++ b/papi-dts/modules/_node_services_execution_token_service_.html @@ -1,2 +1,2 @@ -"node/services/execution-token.service" | papi-dts

    Namespace "node/services/execution-token.service"

    Index

    Variables

    default +"node/services/execution-token.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_services_node_file_system_service_.html b/papi-dts/modules/_node_services_node_file_system_service_.html index f0c0c78420..1010d15a50 100644 --- a/papi-dts/modules/_node_services_node_file_system_service_.html +++ b/papi-dts/modules/_node_services_node_file_system_service_.html @@ -1,4 +1,4 @@ -"node/services/node-file-system.service" | papi-dts

    Namespace "node/services/node-file-system.service"

    Index

    Enumerations

    EntryType +"node/services/node-file-system.service" | papi-dts

    Namespace "node/services/node-file-system.service"

    Index

    Enumerations

    Type Aliases

    Functions

    copyFile createDir diff --git a/papi-dts/modules/_node_utils_crypto_util_.html b/papi-dts/modules/_node_utils_crypto_util_.html index 1fb773906d..34624333d1 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,3 +1,3 @@ -"node/utils/crypto-util" | papi-dts

    Namespace "node/utils/crypto-util"

    Index

    Functions

    createNonce +"node/utils/crypto-util" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_utils_util_.html b/papi-dts/modules/_node_utils_util_.html index 9a1a92fc64..35224fae26 100644 --- a/papi-dts/modules/_node_utils_util_.html +++ b/papi-dts/modules/_node_utils_util_.html @@ -1,4 +1,4 @@ -"node/utils/util" | papi-dts

    Namespace "node/utils/util"

    Index

    Variables

    FILE_PROTOCOL +"node/utils/util" | papi-dts

    Namespace "node/utils/util"

    Index

    Variables

    Functions

    getAppDir getPathFromUri diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index 5f5446965f..b173d97c1f 100644 --- a/papi-dts/modules/_papi_shared_types_.html +++ b/papi-dts/modules/_papi_shared_types_.html @@ -1,4 +1,4 @@ -"papi-shared-types" | papi-dts

    Namespace "papi-shared-types"

    Index

    Interfaces

    CommandHandlers +"papi-shared-types" | papi-dts

    Namespace "papi-shared-types"

    Index

    Interfaces

    CommandHandlers DataProviders ProjectDataProviders ProjectSettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index d6b598c182..61ea89548f 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-base.data" | papi-dts

    Namespace "renderer/components/dialogs/dialog-base.data"

    Index

    Type Aliases

    DialogDefinitionBase +"renderer/components/dialogs/dialog-base.data" | papi-dts

    Namespace "renderer/components/dialogs/dialog-base.data"

    Index

    Type Aliases

    Variables

    Functions

    hookUpDialogService diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html index 4b15df5220..3570bffe6e 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-definition.model" | papi-dts

    Namespace "renderer/components/dialogs/dialog-definition.model"

    Index

    Interfaces

    DialogTypes +"renderer/components/dialogs/dialog-definition.model" | papi-dts

    Namespace "renderer/components/dialogs/dialog-definition.model"

    Index

    Interfaces

    Type Aliases

    DialogDataTypes DialogDefinition DialogTabTypes diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html index 745de26835..37f1b8ae18 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

    Namespace "renderer/hooks/hook-generators/create-use-data-hook.util"

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html index f041054906..739b2275d3 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

    Namespace "renderer/hooks/hook-generators/create-use-network-object-hook.util"

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index 26dfbcdd8a..23e45edad1 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html @@ -1,4 +1,4 @@ -"renderer/hooks/papi-hooks/index" | papi-dts

    Namespace "renderer/hooks/papi-hooks/index"

    References

    useData +"renderer/hooks/papi-hooks/index" | papi-dts

    Namespace "renderer/hooks/papi-hooks/index"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html index c5c825a750..850e6fabd5 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-data.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html index 06eb29a66d..d20589d950 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-data-provider.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html index 91ae2b3103..2ad8303764 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-data-provider-multi.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html index 0e7ef59c39..845f5592b3 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html @@ -1,3 +1,3 @@ -"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-dialog-callback.hook"

    Index

    Type Aliases

    UseDialogCallbackOptions +"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html index 2f411fe0e4..c3dcdc561a 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-project-data.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html index 6393dc828f..feb1f5baad 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-project-data-provider.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html index 4448b61538..c6c671a41f 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-project-setting.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html index d589317d2a..16e1c583f9 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-setting.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html index 0ad8c598ab..72146e8cd9 100644 --- a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html @@ -1,3 +1,3 @@ -"renderer/services/renderer-web-socket.service" | papi-dts

    Namespace "renderer/services/renderer-web-socket.service"

    Index

    Classes

    default +"renderer/services/renderer-web-socket.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html index bbed69179b..9de8a4c88e 100644 --- a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html @@ -1,2 +1,2 @@ -"renderer/services/renderer-xml-http-request.service" | papi-dts

    Namespace "renderer/services/renderer-xml-http-request.service"

    Index

    Classes

    default +"renderer/services/renderer-xml-http-request.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_file_system_model_.html b/papi-dts/modules/_shared_data_file_system_model_.html index 30d4eed265..e7b6eddd17 100644 --- a/papi-dts/modules/_shared_data_file_system_model_.html +++ b/papi-dts/modules/_shared_data_file_system_model_.html @@ -1,2 +1,2 @@ -"shared/data/file-system.model" | papi-dts

    Namespace "shared/data/file-system.model"

    Index

    Type Aliases

    Uri +"shared/data/file-system.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_data_internal_connection_model_.html b/papi-dts/modules/_shared_data_internal_connection_model_.html index 9b300f0453..ae140c39dc 100644 --- a/papi-dts/modules/_shared_data_internal_connection_model_.html +++ b/papi-dts/modules/_shared_data_internal_connection_model_.html @@ -1,4 +1,4 @@ -"shared/data/internal-connection.model" | papi-dts

    Namespace "shared/data/internal-connection.model"

    Index

    Enumerations

    ConnectionStatus +"shared/data/internal-connection.model" | papi-dts

    Namespace "shared/data/internal-connection.model"

    Index

    Enumerations

    Type Aliases

    ClientConnectEvent ClientDisconnectEvent InternalEvent diff --git a/papi-dts/modules/_shared_data_network_connector_model_.html b/papi-dts/modules/_shared_data_network_connector_model_.html index 1980781776..a060b2cb38 100644 --- a/papi-dts/modules/_shared_data_network_connector_model_.html +++ b/papi-dts/modules/_shared_data_network_connector_model_.html @@ -1,4 +1,4 @@ -"shared/data/network-connector.model" | papi-dts

    Namespace "shared/data/network-connector.model"

    Index

    Enumerations

    MessageType +"shared/data/network-connector.model" | papi-dts

    Namespace "shared/data/network-connector.model"

    Index

    Enumerations

    Type Aliases

    ClientConnect InitClient Message diff --git a/papi-dts/modules/_shared_global_this_model_.html b/papi-dts/modules/_shared_global_this_model_.html index 2d01b3cbaf..6d625cb5b3 100644 --- a/papi-dts/modules/_shared_global_this_model_.html +++ b/papi-dts/modules/_shared_global_this_model_.html @@ -1,2 +1,2 @@ -"shared/global-this.model" | papi-dts

    Namespace "shared/global-this.model"

    Index

    Enumerations

    ProcessType +"shared/global-this.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_data_provider_engine_model_.html index 91ea70712e..372df3af79 100644 --- a/papi-dts/modules/_shared_models_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider-engine.model" | papi-dts

    Namespace "shared/models/data-provider-engine.model"

    Index

    Classes

    DataProviderEngine +"shared/models/data-provider-engine.model" | papi-dts

    Namespace "shared/models/data-provider-engine.model"

    Index

    Classes

    Type Aliases

    DataProviderEngineNotifyUpdate WithNotifyUpdate default diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index df90445540..0ecdc7bee4 100644 --- a/papi-dts/modules/_shared_models_data_provider_interface_.html +++ b/papi-dts/modules/_shared_models_data_provider_interface_.html @@ -1,3 +1,3 @@ -"shared/models/data-provider.interface" | papi-dts

    Namespace "shared/models/data-provider.interface"

    Index

    Type Aliases

    IDisposableDataProvider +"shared/models/data-provider.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index f36b06f957..71f576daab 100644 --- a/papi-dts/modules/_shared_models_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider.model" | papi-dts

    Namespace "shared/models/data-provider.model"

    Index

    Type Aliases

    DataProviderDataType +"shared/models/data-provider.model" | papi-dts

    Namespace "shared/models/data-provider.model"

    Index

    Type Aliases

    DataProviderDataType DataProviderDataTypes DataProviderGetter DataProviderGetters diff --git a/papi-dts/modules/_shared_models_dialog_options_model_.html b/papi-dts/modules/_shared_models_dialog_options_model_.html index 35cbe7937d..06554859b1 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,3 +1,3 @@ -"shared/models/dialog-options.model" | papi-dts

    Namespace "shared/models/dialog-options.model"

    Index

    Type Aliases

    DialogData +"shared/models/dialog-options.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index 1699965beb..daa6819e81 100644 --- a/papi-dts/modules/_shared_models_docking_framework_model_.html +++ b/papi-dts/modules/_shared_models_docking_framework_model_.html @@ -1,4 +1,4 @@ -"shared/models/docking-framework.model" | papi-dts

    Namespace "shared/models/docking-framework.model"

    Index

    Interfaces

    FloatLayout +"shared/models/docking-framework.model" | papi-dts

    Namespace "shared/models/docking-framework.model"

    Index

    Interfaces

    Type Aliases

    AddWebViewEvent diff --git a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html index 658b35803f..5eb492a66c 100644 --- a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html +++ b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html @@ -1,2 +1,2 @@ -"shared/models/extract-data-provider-data-types.model" | papi-dts

    Namespace "shared/models/extract-data-provider-data-types.model"

    Index

    Type Aliases

    default +"shared/models/extract-data-provider-data-types.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index 0e78a4b3d8..f45d419545 100644 --- a/papi-dts/modules/_shared_models_network_object_model_.html +++ b/papi-dts/modules/_shared_models_network_object_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object.model" | papi-dts

    Namespace "shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject +"shared/models/network-object.model" | papi-dts

    Namespace "shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject LocalObjectToProxyCreator NetworkObject NetworkObjectDetails diff --git a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html index aa94cbc33a..dd33d6d455 100644 --- a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html +++ b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html @@ -1,2 +1,2 @@ -"shared/models/papi-network-event-emitter.model" | papi-dts

    Namespace "shared/models/papi-network-event-emitter.model"

    Index

    Classes

    default +"shared/models/papi-network-event-emitter.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html index c65dce9166..29ddf18cb0 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace "shared/models/project-data-provider-engine.model"

    Index

    Classes

    ProjectDataProviderEngine +"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace "shared/models/project-data-provider-engine.model"

    Index

    Classes

    Interfaces

    Type Aliases

    IProjectDataProviderEngine ProjectDataProviderEngineTypes diff --git a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html index c961905605..b766b72405 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html @@ -1,2 +1,2 @@ -"shared/models/project-data-provider-factory.interface" | papi-dts

    Namespace "shared/models/project-data-provider-factory.interface"

    Index

    Interfaces

    default +"shared/models/project-data-provider-factory.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_model_.html b/papi-dts/modules/_shared_models_project_data_provider_model_.html index 35fc4378c8..43cc0d6877 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider.model" | papi-dts

    Namespace "shared/models/project-data-provider.model"

    Index

    Type Aliases

    ExtensionDataScope +"shared/models/project-data-provider.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index 8f62e6f42e..ee11115e62 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,2 +1,2 @@ -"shared/models/project-metadata.model" | papi-dts

    Namespace "shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectMetadata +"shared/models/project-metadata.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html b/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html index 9b9453a3c8..95e961beec 100644 --- a/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html +++ b/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-storage-interpreter.model" | papi-dts

    Namespace "shared/models/project-storage-interpreter.model"

    Index

    Type Aliases

    DefaultProjectStorageDataTypes +"shared/models/project-storage-interpreter.model" | papi-dts

    Namespace "shared/models/project-storage-interpreter.model"

    Index

    Type Aliases

    DefaultProjectStorageDataTypes MandatoryProjectStorageDataTypes ProjectStorageExtensionDataScope ProjectStorageProjectDataScope diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index 6db376d0dd..7a42d13e5a 100644 --- a/papi-dts/modules/_shared_models_web_view_model_.html +++ b/papi-dts/modules/_shared_models_web_view_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view.model" | papi-dts

    Namespace "shared/models/web-view.model"

    Index

    Enumerations

    WebViewContentType +"shared/models/web-view.model" | papi-dts

    Namespace "shared/models/web-view.model"

    Index

    Enumerations

    Type Aliases

    GetWebViewDefinitionUpdatableProperties GetWebViewOptions SavedWebViewDefinition diff --git a/papi-dts/modules/_shared_models_web_view_provider_model_.html b/papi-dts/modules/_shared_models_web_view_provider_model_.html index d6c40ba395..2148b946a3 100644 --- a/papi-dts/modules/_shared_models_web_view_provider_model_.html +++ b/papi-dts/modules/_shared_models_web_view_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view-provider.model" | papi-dts

    Namespace "shared/models/web-view-provider.model"

    Index

    Interfaces

    DisposableWebViewProvider +"shared/models/web-view-provider.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index d2eb56748a..dd59019e78 100644 --- a/papi-dts/modules/_shared_services_command_service_.html +++ b/papi-dts/modules/_shared_services_command_service_.html @@ -1,4 +1,4 @@ -"shared/services/command.service" | papi-dts

    Namespace "shared/services/command.service"

    Index

    Type Aliases

    moduleSummaryComments +"shared/services/command.service" | papi-dts

    Namespace "shared/services/command.service"

    Index

    Type Aliases

    Functions

    addThree createSendCommandFunction initialize diff --git a/papi-dts/modules/_shared_services_connection_service_.html b/papi-dts/modules/_shared_services_connection_service_.html index b098577c98..76c865d7f8 100644 --- a/papi-dts/modules/_shared_services_connection_service_.html +++ b/papi-dts/modules/_shared_services_connection_service_.html @@ -1,4 +1,4 @@ -"shared/services/connection.service" | papi-dts

    Namespace "shared/services/connection.service"

    Index

    Functions

    connect +"shared/services/connection.service" | papi-dts

    Namespace "shared/services/connection.service"

    Index

    Functions

    connect disconnect emitEventOnNetwork getClientId diff --git a/papi-dts/modules/_shared_services_data_provider_service_.html b/papi-dts/modules/_shared_services_data_provider_service_.html index 1ff214d77d..f968be3d7d 100644 --- a/papi-dts/modules/_shared_services_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/data-provider.service" | papi-dts

    Namespace "shared/services/data-provider.service"

    Index

    Interfaces

    DataProviderService +"shared/services/data-provider.service" | papi-dts

    Namespace "shared/services/data-provider.service"

    Index

    Interfaces

    Variables

    Functions

    getByType registerEngineByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index 468876295f..3ea8cee2d2 100644 --- a/papi-dts/modules/_shared_services_dialog_service_.html +++ b/papi-dts/modules/_shared_services_dialog_service_.html @@ -1,2 +1,2 @@ -"shared/services/dialog.service" | papi-dts

    Namespace "shared/services/dialog.service"

    Index

    Variables

    default +"shared/services/dialog.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index ca72566432..b00e56c4d8 100644 --- a/papi-dts/modules/_shared_services_dialog_service_model_.html +++ b/papi-dts/modules/_shared_services_dialog_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/dialog.service-model" | papi-dts

    Namespace "shared/services/dialog.service-model"

    Index

    Interfaces

    DialogService +"shared/services/dialog.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index 01b9a97bec..852c847927 100644 --- a/papi-dts/modules/_shared_services_internet_service_.html +++ b/papi-dts/modules/_shared_services_internet_service_.html @@ -1,3 +1,3 @@ -"shared/services/internet.service" | papi-dts

    Namespace "shared/services/internet.service"

    Index

    Interfaces

    InternetService +"shared/services/internet.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 92cb53ba05..70bf1397a1 100644 --- a/papi-dts/modules/_shared_services_logger_service_.html +++ b/papi-dts/modules/_shared_services_logger_service_.html @@ -1,4 +1,4 @@ -"shared/services/logger.service" | papi-dts

    Namespace "shared/services/logger.service"

    Index

    Variables

    WARN_TAG +"shared/services/logger.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_menu_data_service_.html b/papi-dts/modules/_shared_services_menu_data_service_.html index 903b1ca77e..67fc72709e 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_.html @@ -1,2 +1,2 @@ -"shared/services/menu-data.service" | papi-dts

    Namespace "shared/services/menu-data.service"

    Index

    Variables

    default +"shared/services/menu-data.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_menu_data_service_model_.html b/papi-dts/modules/_shared_services_menu_data_service_model_.html index d3fe2ec4fb..7fbc595c3c 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_model_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/menu-data.service-model" | papi-dts

    Namespace "shared/services/menu-data.service-model"

    Index

    Type Aliases

    IMenuDataService +"shared/services/menu-data.service-model" | papi-dts

    Namespace "shared/services/menu-data.service-model"

    Index

    Type Aliases

    Variables

    menuDataServiceObjectToProxy menuDataServiceProviderName diff --git a/papi-dts/modules/_shared_services_network_connector_factory_.html b/papi-dts/modules/_shared_services_network_connector_factory_.html index 181154a3b9..b7eade50e3 100644 --- a/papi-dts/modules/_shared_services_network_connector_factory_.html +++ b/papi-dts/modules/_shared_services_network_connector_factory_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.factory" | papi-dts

    Namespace "shared/services/network-connector.factory"

    Index

    Functions

    createNetworkConnector +"shared/services/network-connector.factory" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_interface_.html b/papi-dts/modules/_shared_services_network_connector_interface_.html index 14756f56a2..9992ffad99 100644 --- a/papi-dts/modules/_shared_services_network_connector_interface_.html +++ b/papi-dts/modules/_shared_services_network_connector_interface_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.interface" | papi-dts

    Namespace "shared/services/network-connector.interface"

    Index

    Interfaces

    default +"shared/services/network-connector.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index 23ef93a95e..241cd6c7a1 100644 --- a/papi-dts/modules/_shared_services_network_object_service_.html +++ b/papi-dts/modules/_shared_services_network_object_service_.html @@ -1,4 +1,4 @@ -"shared/services/network-object.service" | papi-dts

    Namespace "shared/services/network-object.service"

    Index

    Variables

    default +"shared/services/network-object.service" | papi-dts

    Namespace "shared/services/network-object.service"

    Index

    Variables

    Functions

    onDidCreateNetworkObject onDidDisposeNetworkObject overrideDispose diff --git a/papi-dts/modules/_shared_services_network_object_status_service_.html b/papi-dts/modules/_shared_services_network_object_status_service_.html index 326a11585c..704de26bac 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_.html @@ -1,2 +1,2 @@ -"shared/services/network-object-status.service" | papi-dts

    Namespace "shared/services/network-object-status.service"

    Index

    Variables

    default +"shared/services/network-object-status.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_status_service_model_.html b/papi-dts/modules/_shared_services_network_object_status_service_model_.html index 5f61921f68..72fb2e0b67 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/network-object-status.service-model" | papi-dts

    Namespace "shared/services/network-object-status.service-model"

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType +"shared/services/network-object-status.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index cb5c229b03..8c24ce37fa 100644 --- a/papi-dts/modules/_shared_services_network_service_.html +++ b/papi-dts/modules/_shared_services_network_service_.html @@ -1,4 +1,4 @@ -"shared/services/network.service" | papi-dts

    Namespace "shared/services/network.service"

    Index

    Interfaces

    PapiNetworkService +"shared/services/network.service" | papi-dts

    Namespace "shared/services/network.service"

    Index

    Interfaces

    Type Aliases

    ArgsRequestHandler ComplexRequestHandler ContentsRequestHandler diff --git a/papi-dts/modules/_shared_services_project_data_provider_service_.html b/papi-dts/modules/_shared_services_project_data_provider_service_.html index 35ced6fe14..79b7093163 100644 --- a/papi-dts/modules/_shared_services_project_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_project_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/project-data-provider.service" | papi-dts

    Namespace "shared/services/project-data-provider.service"

    Index

    Interfaces

    PapiBackendProjectDataProviderService +"shared/services/project-data-provider.service" | papi-dts

    Namespace "shared/services/project-data-provider.service"

    Index

    Interfaces

    Variables

    papiBackendProjectDataProviderService papiFrontendProjectDataProviderService diff --git a/papi-dts/modules/_shared_services_project_lookup_service_.html b/papi-dts/modules/_shared_services_project_lookup_service_.html index f285d2aed9..3c087e3554 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,3 +1,3 @@ -"shared/services/project-lookup.service" | papi-dts

    Namespace "shared/services/project-lookup.service"

    Index

    Variables

    default +"shared/services/project-lookup.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_lookup_service_model_.html b/papi-dts/modules/_shared_services_project_lookup_service_model_.html index c3a4c8476f..1c5b9923c8 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-lookup.service-model" | papi-dts

    Namespace "shared/services/project-lookup.service-model"

    Index

    Interfaces

    ProjectLookupServiceType +"shared/services/project-lookup.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_settings_service_.html b/papi-dts/modules/_shared_services_project_settings_service_.html index 9c6ddfa56f..7b6b0493f7 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-settings.service" | papi-dts

    Namespace "shared/services/project-settings.service"

    Index

    Variables

    default +"shared/services/project-settings.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_settings_service_model_.html b/papi-dts/modules/_shared_services_project_settings_service_model_.html index d9d335d16f..a5422f81a7 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-settings.service-model" | papi-dts

    Namespace "shared/services/project-settings.service-model"

    Index

    Interfaces

    IProjectSettingsService +"shared/services/project-settings.service-model" | papi-dts

    Namespace "shared/services/project-settings.service-model"

    Index

    Interfaces

    Type Aliases

    AllProjectSettingsValidators ProjectSettingValidator SimultaneousProjectSettingsChanges diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index 7da99dc931..1ec6d1b1fa 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Variables

    default +"shared/services/settings.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_settings_service_model_.html b/papi-dts/modules/_shared_services_settings_service_model_.html index 0928390583..22f1d7f433 100644 --- a/papi-dts/modules/_shared_services_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service-model" | papi-dts

    Namespace "shared/services/settings.service-model"

    Index

    Type Aliases

    AllSettingsData +"shared/services/settings.service-model" | papi-dts

    Namespace "shared/services/settings.service-model"

    Index

    Type Aliases

    AllSettingsData AllSettingsValidators ISettingsService SettingDataTypes diff --git a/papi-dts/modules/_shared_services_web_view_provider_service_.html b/papi-dts/modules/_shared_services_web_view_provider_service_.html index 4f87e30e39..a026a29916 100644 --- a/papi-dts/modules/_shared_services_web_view_provider_service_.html +++ b/papi-dts/modules/_shared_services_web_view_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/web-view-provider.service" | papi-dts

    Namespace "shared/services/web-view-provider.service"

    Index

    Interfaces

    PapiWebViewProviderService +"shared/services/web-view-provider.service" | papi-dts

    Namespace "shared/services/web-view-provider.service"

    Index

    Interfaces

    Variables

    default papiWebViewProviderService diff --git a/papi-dts/modules/_shared_services_web_view_service_.html b/papi-dts/modules/_shared_services_web_view_service_.html index 946faa5079..7c4f5635a7 100644 --- a/papi-dts/modules/_shared_services_web_view_service_.html +++ b/papi-dts/modules/_shared_services_web_view_service_.html @@ -1,2 +1,2 @@ -"shared/services/web-view.service" | papi-dts

    Namespace "shared/services/web-view.service"

    Index

    Variables

    default +"shared/services/web-view.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_web_view_service_model_.html b/papi-dts/modules/_shared_services_web_view_service_model_.html index 76054105be..028f0312b7 100644 --- a/papi-dts/modules/_shared_services_web_view_service_model_.html +++ b/papi-dts/modules/_shared_services_web_view_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/web-view.service-model" | papi-dts

    Namespace "shared/services/web-view.service-model"

    Index

    Interfaces

    WebViewServiceType +"shared/services/web-view.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index c0c4f6e00f..9bfbbd9fe0 100644 --- a/papi-dts/modules/_shared_utils_internal_util_.html +++ b/papi-dts/modules/_shared_utils_internal_util_.html @@ -1,4 +1,4 @@ -"shared/utils/internal-util" | papi-dts

    Namespace "shared/utils/internal-util"

    Index

    Functions

    getProcessType +"shared/utils/internal-util" | papi-dts

    Namespace "shared/utils/internal-util"

    Index

    Functions

    getProcessType isClient isExtensionHost isRenderer diff --git a/papi-dts/modules/_shared_utils_util_.html b/papi-dts/modules/_shared_utils_util_.html index 23718703f4..01ae5f7b76 100644 --- a/papi-dts/modules/_shared_utils_util_.html +++ b/papi-dts/modules/_shared_utils_util_.html @@ -1,4 +1,4 @@ -"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Enumerations

    RequestHandlerType +"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Enumerations

    Type Aliases

    ComplexRequest ComplexResponse ComplexResponseFailure diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 1f92e22e8e..a26860d604 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +Papi | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html index 0d71b57976..3de0275204 100644 --- a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html +++ b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html @@ -3,4 +3,4 @@ ClientNetworkConnector. For now, we are just using the browser WebSocket type. We may need specific functionality that don't line up between the ws library's implementation and the browser implementation. We can adjust as needed at that point.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html index 492a56567c..20283b52c3 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html +++ b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html @@ -2,4 +2,4 @@

    Type declaration

    • executionToken: ExecutionToken

      Used to save and load data from the storage service.

    • name: string

      Canonical name of the extension

    • registrations: UnsubscriberAsyncList

      Tracks all registrations made by an extension so they can be cleaned up when it is unloaded

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html index 0139a064c5..388b3fbfea 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html +++ b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html @@ -21,4 +21,4 @@ for more information about extension type declaration files.

  • version: string

    Extension version - expected to be semver like "0.1.3".

    Note: semver may become a hard requirement in the future, so we recommend using it now.

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html index fda281fe69..c911b7d3b1 100644 --- a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html +++ b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html @@ -1,2 +1,2 @@ ExecutionTokenType | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html index a861378224..73435861e6 100644 --- a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html +++ b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html @@ -1,2 +1,2 @@ DirectoryEntries | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index 0adb54107d..87c42861e8 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' commands that are added to CommandHandlers.

    Example

    'platform.quit';
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index 782aadab9f..12ba11d2b6 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    'platform.placeholder'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index 3819ecd17a..8cb92a6a8e 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -3,4 +3,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    DataProviderTypes['helloSomeone.people'] => {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index 9045b6b88b..63de0acf69 100644 --- a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html +++ b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html @@ -2,4 +2,4 @@ returned from papi.dataProviders.registerEngine - only the one who registers a data provider engine is allowed to dispose of the data provider.

    Automatically includes all extensions' data providers that are added to DataProviders.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index bc08902a6a..77bf2ddfaa 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html @@ -29,4 +29,4 @@

    Returns

    Unsubscriber to stop listening for updates

  • callback: ((value) => void)

    Function to run with the updated project setting value

  • options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html b/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html index e0c710481d..5bb8b7aaa7 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html +++ b/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html @@ -87,4 +87,4 @@

    Returns

    Unsubscriber to stop listening for updates

  • callback: ((value) => void)

    Function to run with the updated project setting value

  • options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 3b5cf8d696..5873be3805 100644 --- a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html @@ -1,2 +1,2 @@ NotesOnlyProjectDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index 7e116f8ff6..7ea220bf71 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +PlaceholderDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html index 251d35816a..3fdbd11310 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html @@ -6,4 +6,4 @@ provider data types.

    Example

    ProjectDataTypes['MyExtensionProjectTypeName'] => MandatoryProjectDataTypes & {
    MyProjectData: DataProviderDataType<string, string, string>;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index ccb30a5aeb..897cf571d1 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html +++ b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html @@ -3,4 +3,4 @@ ProjectSettingTypes.

    Example

    'platform.fullName'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html index 28f23bf07e..d65a7ff7ba 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html @@ -7,4 +7,4 @@ Interpreters.

    Example

    ProjectStorageDataTypes['MyExtensionProjectTypeName'] => MandatoryProjectStorageDataTypes & {
    ProjectData: DataProviderDataType<
    { projectId: string; section: number },
    string | undefined,
    string
    >;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html index aa9da99b8f..b776af29f0 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html @@ -8,4 +8,4 @@ make PSIs available to support the PDPs available.

    Example

    'platform.notesOnly'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html b/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html index 800e46b12c..6cf54d500c 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html @@ -3,4 +3,4 @@ PSI and adds the projectId.

    Type Parameters

    Type declaration

    • key: ProjectSettingName

      Key of the Project Setting to select

    • projectId: string

      ID for the project whose extension data to get

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectTypes.html index f099ce2680..39ebb879cc 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -7,4 +7,4 @@ make PSIs available to support the PDPs available.

    Example

    'platform.notesOnly'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 5ee300685a..016541ea00 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' user settings that are added to SettingTypes.

    Example

    'platform.verseRef'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index da1a72bc72..bd37d743c1 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +StuffDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html index a1f38bec3a..5036445fae 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -48,4 +48,4 @@

    See

    Throws

    If the setting validator failed.

    See

    DataProviderUpdateInstructions for more info on what to return

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html index 51f7834d91..e61838a3fe 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html @@ -15,4 +15,4 @@

    TODO: preserve requests between refreshes - save the dialog info in such a way that it works when loading again after refresh

  • Optional tabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html index 311b4374c0..e0716a3538 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html @@ -1,7 +1,7 @@ DialogProps | papi-dts
    DialogProps<TData>: DialogData & {
        cancelDialog(): void;
        rejectDialog(errorMessage): void;
        submitDialog(data): void;
    }

    Props provided to the dialog component

    Type Parameters

    • TData = unknown

    Type declaration

    • cancelDialog:function
      • Cancels the dialog request (resolves the response with undefined) and closes the dialog

        -

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        Parameters

        • errorMessage: string

          Message to explain why the dialog request was rejected

          -

        Returns void

    • submitDialog:function
      • Sends the data as a resolved response to the dialog request and closes the dialog

        +

    Returns void

  • submitDialog:function
    • Sends the data as a resolved response to the dialog request and closes the dialog

      Parameters

      • data: TData

        Data with which to resolve the request

        -

      Returns void

  • Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html index 8896d68ac4..e26bd9e91a 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html @@ -5,4 +5,4 @@ as props

  • props: DialogProps<TReturnType> & TOptions

    Props provided to the dialog component

  • responseType: TReturnType

    The type of the response to the dialog request

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html index 637983e234..64427b9355 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html @@ -1 +1 @@ -DialogDefinition | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +DialogDefinition | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html index 5d671e791f..4889a7617f 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html @@ -1,2 +1,2 @@ DialogTabTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html index dc86f88161..54eb135a7d 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html @@ -1 +1 @@ -ProjectDialogOptionsBase | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +ProjectDialogOptionsBase | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index 786812bc4b..8fd80b83cb 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html @@ -1,3 +1,3 @@ SelectMultipleProjectsDialogOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html index 62332680c7..f0c19363ae 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html @@ -1,2 +1,2 @@ SelectProjectDialogOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html index 1b5c6aaf72..3afa089ffe 100644 --- a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html +++ b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html @@ -1,4 +1,4 @@ UseDialogCallbackOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_file_system_model_.Uri.html b/papi-dts/types/_shared_data_file_system_model_.Uri.html index e945211be6..2fc126cb1b 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -24,4 +24,4 @@

    Note: projects are stored in the production version of app://projects regardless of whether you are in production or development

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html index e282927e05..ad2f5b0066 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html @@ -1,2 +1,2 @@ ClientConnectEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html index a981dd6665..8befff6fbd 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html @@ -1,2 +1,2 @@ ClientDisconnectEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html index f27e20a448..229a785a33 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html @@ -1,4 +1,4 @@ InternalEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html index 0ab926fcd4..a775a58658 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html @@ -1,3 +1,3 @@ InternalNetworkEventHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • <T>(eventType, incomingEvent): void
      • Type Parameters

        • T

        Parameters

        Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html index a2164b684b..c33ffe387e 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html @@ -1,2 +1,2 @@ InternalRequest | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html index 969aa4b32e..3800f524b3 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html @@ -1,3 +1,3 @@ InternalRequestHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html index c1e11522c6..30617efa87 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html @@ -1,4 +1,4 @@ InternalResponse | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html index 3ea1b99ffc..6e374392ef 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html @@ -4,4 +4,4 @@
      • (event): void
      • Handles when a new connection is established

        Parameters

        Returns void

  • Optional didClientDisconnectHandler?: ((event) => void)

    Handles when a client disconnects

  • Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html index c40cb2fd0e..5ef313b792 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html @@ -1,2 +1,2 @@ NetworkConnectorInfo | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html index 2f91c1236f..dea48b6d37 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html @@ -1,2 +1,2 @@ NetworkEventHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • <T>(eventType, event): void
      • Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html index 49280670e5..3ea04f7e06 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html @@ -1,2 +1,2 @@ RequestHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html index 000eb61760..f01d68dbe1 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html @@ -1,2 +1,2 @@ RequestRouter | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • (requestType): number
      • Parameters

        • requestType: string

        Returns number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html index cc5f25680d..939ddeb038 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html +++ b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html @@ -3,4 +3,4 @@ (like if the browser refreshes): if the server has a connection with this clientGuid, it will unregister all requests on that client so the reconnecting client can register its request handlers again.

    -
  • senderId: number
  • type: ClientConnect
  • Generated using TypeDoc

    \ No newline at end of file +
  • senderId: number
  • type: ClientConnect
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html index 3e8d12e6f6..f0d0bbff91 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html +++ b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html @@ -1,3 +1,3 @@ InitClient | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +
  • connectorInfo: NetworkConnectorInfo
  • senderId: number
  • type: InitClient
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.Message.html b/papi-dts/types/_shared_data_network_connector_model_.Message.html index 62f89e4d26..c34e20e222 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.Message.html +++ b/papi-dts/types/_shared_data_network_connector_model_.Message.html @@ -1,2 +1,2 @@ Message | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html index 92ac7ce2e3..2b217b8313 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html @@ -1,3 +1,3 @@ WebSocketEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Event
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html index 8fe792f4d2..a42415838d 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html @@ -1,3 +1,3 @@ WebSocketRequest | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Request
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html index 3769e57993..b8bbf41120 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html @@ -1,3 +1,3 @@ WebSocketResponse | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +
  • type: Response
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html index 64e994b2dc..6ad1331f35 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html @@ -20,4 +20,4 @@

    @see DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Type Parameters

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html index 12507a11e5..a1a28ff5fb 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html @@ -27,4 +27,4 @@
  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html index d3037bf8b1..314b6c4faa 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html @@ -23,4 +23,4 @@

    OR

    class MyDPE implements IDataProviderEngine<MyDataTypes> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<MyDataTypes>) {}
    ...
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html index a632bbb40a..bae76c6351 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html @@ -2,4 +2,4 @@ data provider (only the service that set it up should dispose of it) with dataProviderService.registerEngine

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.default.html b/papi-dts/types/_shared_models_data_provider_interface_.default.html index 29eeaecb5b..bb2e03a9d7 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.default.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.default.html @@ -3,4 +3,4 @@ getting a data provider with papi.dataProviders.get.

    Note: each set<data_type> method has a corresponding get<data_type> and subscribe<data_type> method.

    -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html index 947a4acf62..9419d3d929 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html @@ -7,4 +7,4 @@ wants at this data type.

  • setData: TSetData

    The type of data ingested by this data provider when you run set<data_type> based on a provided selector

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html index ff9dbcc4c3..aa8f28b669 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html @@ -7,4 +7,4 @@ following:

    {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    All: DataProviderDataType<undefined, { greeting: string, age: number }, never>;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html index e9d88ce69c..95443f64de 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html @@ -4,4 +4,4 @@ up-to-date.

    Type Parameters

    Type declaration

      • (selector): Promise<TDataType["getData"]>
      • Parameters

        • selector: TDataType["selector"]

          Tells the provider what subset of data to get

        Returns Promise<TDataType["getData"]>

    Returns

    The subset of data represented by the selector

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html index c71b7eb01e..98d3c29453 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html @@ -1,3 +1,3 @@ DataProviderGetters | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html index 9be068b104..890bc520eb 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html @@ -6,4 +6,4 @@

    Returns Promise<DataProviderUpdateInstructions<TDataTypes>>

    Returns

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    See

    DataProviderUpdateInstructions for more info on what to return

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html index bf213ab24e..3d6a5d1c9a 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html @@ -1,3 +1,3 @@ DataProviderSetters | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html index 8b3fb752ab..17e62962c2 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html @@ -8,4 +8,4 @@
  • callback: PlatformEventHandler<TDataType["getData"]>

    Function to run with the updated data for this selector

  • Optional options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Returns

    Unsubscriber to stop listening for updates

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html index 8a41bed4f5..53693c66ef 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html @@ -21,4 +21,4 @@

    Default

    'deeply-equal'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html index 0421291e61..195c33b753 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html @@ -1,4 +1,4 @@ DataProviderSubscribers | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html index 2bb1ad4688..444371d0ca 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html @@ -16,4 +16,4 @@
  • false (or falsy) do not update subscriptions

  • -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html index 26858a6dcb..bc8dac4de1 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html @@ -1,4 +1,4 @@ DataTypeNames | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.default.html b/papi-dts/types/_shared_models_data_provider_model_.default.html index b2e1851a6b..96328f17ff 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_model_.default.html @@ -2,4 +2,4 @@ object layers over the data provider engine and runs its methods along with other methods. This object is transformed into an IDataProvider by networkObjectService.set.

    Type Parameters

    See

    IDataProvider

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html index 8267b71081..03141503d9 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html @@ -1,2 +1,2 @@ DialogData | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • isDialog: true

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html index 0b53271bee..e824faa564 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional iconUrl?: string

      Url of dialog icon to display in the header. Default is Platform.Bible logo

    • Optional prompt?: string

      The message to show the user in the dialog. Default depends on the dialog

    • Optional title?: string

      Dialog title to display in the header. Default depends on the dialog

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html index 1827a41bac..e5a07dbb4b 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html @@ -1,2 +1,2 @@ AddWebViewEvent | papi-dts
    AddWebViewEvent: {
        layout: Layout;
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are created

    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index 26486ede7f..a9991dc805 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html @@ -4,4 +4,4 @@ window
  • center - center the window in the dock layout
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html index 02f5f8fd8f..58542cde5a 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html @@ -1,2 +1,2 @@ FloatSize | papi-dts
    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -

    Type declaration

    • height: number
    • width: number

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html index 39a203f557..c73b7e7c80 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html @@ -1,2 +1,2 @@ Layout | papi-dts

    Information about how a Paranext tab fits into the dock layout

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html index 13bb8f668d..bf742da0d6 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html @@ -1,2 +1,2 @@ OnLayoutChangeRCDock | papi-dts
    OnLayoutChangeRCDock: ((newLayout, currentTabId?, direction?) => Promise<void>)

    Rc-dock's onLayoutChange prop made asynchronous - resolves

    -

    Type declaration

      • (newLayout, currentTabId?, direction?): Promise<void>
      • Parameters

        • newLayout: LayoutBase
        • Optional currentTabId: string
        • Optional direction: DropDirection

        Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html index 497740042e..9766e8df97 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html @@ -1 +1 @@ -PanelDirection | papi-dts
    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Generated using TypeDoc

    \ No newline at end of file +PanelDirection | papi-dts
    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html index 3204b38467..c0f0b54b65 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -47,4 +47,4 @@

    Returns

    True if successfully found the WebView to update; false other

  • updateInfo: WebViewDefinitionUpdateInfo

    Properties to update on the WebView. Any unspecified properties will stay the same

  • Returns boolean

    True if successfully found the WebView to update; false otherwise

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html index 8a9306d68b..aebe8fdf77 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html @@ -7,4 +7,4 @@
  • id: string

    Tab ID - a unique identifier that identifies this tab. If this tab is a WebView, this ID will match the WebViewDefinition.id

  • tabType: string

    Type of tab - indicates what kind of built-in tab this info represents

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html index 5aee498a70..910879ff06 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html @@ -10,4 +10,4 @@

    Defaults to Platform.Bible logo

  • tabTitle: string

    Text to show on the title bar of the tab

  • Optional tabTooltip?: string

    Text to show when hovering over the title bar of the tab

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html index f306f09e20..b45029bd3f 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html @@ -1,4 +1,4 @@ TabLoader | papi-dts
    TabLoader: ((savedTabInfo) => TabInfo)

    Function that takes a SavedTabInfo and creates a Paranext tab out of it. Each type of tab must provide a TabLoader.

    For now all tab creators must do their own data type verification

    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html index 30f6b8e6dd..01fbf51151 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html @@ -3,4 +3,4 @@ stripped from TabInfo by saveTabInfoBase before saving (so it is just a SavedTabInfo).

    Type declaration

    Returns

    The saved tab info for Paranext to persist. If undefined, does not save the tab

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html index 6ef006c631..dab534f255 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html @@ -1,2 +1,2 @@ WebViewTabProps | papi-dts
    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index d0ed2693f1..cd77801fce 100644 --- a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html +++ b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html @@ -3,4 +3,4 @@

    Works with generic types IDataProvider, DataProviderInternal, IDisposableDataProvider, and IDataProviderEngine along with the papi-shared-types extensible interfaces DataProviders and DisposableDataProviders

    -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html index a2e7d02e40..290087554b 100644 --- a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html @@ -1,3 +1,3 @@ DisposableNetworkObject | papi-dts
    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

    An object of this type is returned from networkObjectService.set.

    Type Parameters

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html index 4ecd999892..18c9b82e8c 100644 --- a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html +++ b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html @@ -9,4 +9,4 @@ (probably has to do with that it's a wrapped and layered type). Functions that implement this type should return Partial

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html index 6aa821e76d..8275d7249e 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html @@ -5,4 +5,4 @@ call that method. This is because we don't want users of network objects to dispose of them. Only the caller of networkObjectService.set should be able to dispose of the network object.

    Type Parameters

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html index 2344c86b9c..8fd3a3f942 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html @@ -8,4 +8,4 @@ Data Providers => pdp) should be the same across all process on the network regardless of what programming language they use. For generic network objects, networkObject is appropriate.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html index be85711ab7..3e26ebd409 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html @@ -1,3 +1,3 @@ NetworkableObject | papi-dts
    NetworkableObject<T>: T & CannotHaveOnDidDispose

    An object of this type is passed into networkObjectService.set.

    Type Parameters

    • T = object

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html index dbc1cf82fd..ac634da941 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html @@ -27,4 +27,4 @@

    OR

    class MyPDPE implements IProjectDataProviderEngine<'MyProjectData'> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
    ...
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html index bb856c3c06..66ec0b5181 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html @@ -1,2 +1,2 @@ ProjectDataProviderEngineTypes | papi-dts
    ProjectDataProviderEngineTypes: {
        [ProjectType in ProjectTypes]: IProjectDataProviderEngine<ProjectType>
    }

    All possible types for ProjectDataProviderEngines: IProjectDataProviderEngine

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html index 6802784bda..993e3dcf26 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html @@ -9,4 +9,4 @@

    This is the smallest level of granularity provided by a PDP for accessing extension data. There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • extensionName: string

    Name of an extension as provided in its manifest

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html index 2f9546d21d..4ee22ce656 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html @@ -33,4 +33,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html index e9aeb2bea0..867a6fcbba 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html @@ -7,11 +7,11 @@ to this Project Data Provider

    Returns Promise<undefined | string>

    Extension project data in this project for an extension to use in serving its extension project data

    -
  • setExtensionData:function
  • setExtensionData:function
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html index 903c6e0bac..cc9312e5ca 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -5,4 +5,4 @@
  • projectType: ProjectTypes

    Indicates what sort of project this is which implies its data shape (e.g., what data streams should be available)

  • storageType: string

    Indicates how the project is persisted to storage

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html index 3ee68a3cc2..f1ea1793e0 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html @@ -20,4 +20,4 @@
  • This is an easy pattern to follow when starting to learn how to make new projectTypes in Platform.Bible.
  • -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html index e025ce5a19..e97e29c898 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html @@ -50,4 +50,4 @@ so following this interface ensures your PSI will not break if such a requirement is implemented. -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html index 34b8093ce3..da6214b5c2 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html @@ -1,4 +1,4 @@ ProjectStorageExtensionDataScope | papi-dts
    ProjectStorageExtensionDataScope: ExtensionDataScope & {
        projectId: string;
    }

    Indicates to a PSI what extension data is being referenced on what project. Generally, a PDP passes calls to ExtensionData data type methods to its PSI and adds the projectId.

    Type declaration

    • projectId: string

      ID for the project whose extension data to get

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html index 08131067e2..e0a59bfd4a 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html @@ -10,4 +10,4 @@ There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • projectId: string

    ID for the project whose raw data chunk to get

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html index 67bdede8d8..6d6b6adf84 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ GetWebViewDefinitionUpdatableProperties | papi-dts
    GetWebViewDefinitionUpdatableProperties: (() => WebViewDefinitionUpdatableProperties | undefined)

    Gets the updatable properties on this WebView's WebView definition

    @returns updatable properties this WebView's WebView definition or undefined if not found for some reason

    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html index 99e4230ef9..97a31722d2 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html @@ -11,4 +11,4 @@

    Note: setting existingId to undefined counts as providing in this case (providing is tested with 'existingId' in options, not just testing if existingId is truthy). Not providing an existingId at all is the only way to specify we are not looking for an existing webView

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html index edf16048bb..881b877acc 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html @@ -1,4 +1,4 @@ SavedWebViewDefinition | papi-dts
    SavedWebViewDefinition: (Partial<Omit<WebViewDefinitionReact, "content" | "styles" | "allowScripts">> | Partial<Omit<WebViewDefinitionHtml, "content" | "allowScripts">> | Partial<Omit<WebViewDefinitionURL, "content" | "allowScripts">>) & Pick<WebViewDefinitionBase, "id" | "webViewType">

    Saved WebView information that does not contain the actual content of the WebView. Saved into layouts. Could have as little as the type and ID. WebView providers load these into actual WebViewDefinitions and verify any existing properties on the WebViews.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html index c64fd6d20b..1c2a3b3545 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -5,4 +5,4 @@

    @example

    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html index 32eae1ce0b..ac1ca0f86e 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -24,4 +24,4 @@

    @example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html index b5db6d84aa..8def583ce2 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html @@ -1,2 +1,2 @@ WebViewDefinition | papi-dts

    Properties defining a type of WebView created by extensions to show web content

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html index c6eba1a954..92c3a3eb14 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -65,4 +65,4 @@
  • Optional title?: string

    Name of the tab for the WebView

  • Optional tooltip?: string

    Tooltip that is shown when hovering over the webview title

  • webViewType: WebViewType

    What type of WebView this is. Unique to all other WebView definitions

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html index 4c02cd1ab8..ccd9a793a5 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html @@ -1,3 +1,3 @@ WebViewDefinitionHtml | papi-dts
    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html index 701f8156c1..8ed94b1e17 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html @@ -1,4 +1,4 @@ WebViewDefinitionReact | papi-dts
    WebViewDefinitionReact: WebViewDefinitionBase & {
        contentType?: React;
        styles?: string;
    }

    WebView representation using React

    Type declaration

    • Optional contentType?: React

      Indicates this WebView uses React

    • Optional styles?: string

      String of styles to be loaded into the iframe for this WebView

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html index fcb672b4a5..a669867dbc 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html @@ -1,4 +1,4 @@ WebViewDefinitionURL | papi-dts
    WebViewDefinitionURL: WebViewDefinitionBase & {
        contentType: URL;
    }

    WebView representation using a URL.

    Note: you can only use papi-extension: and https: urls

    Type declaration

    • contentType: URL

      Indicates this WebView uses a URL

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html index 2c82f80b3e..8e818b5375 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html @@ -1,2 +1,2 @@ WebViewDefinitionUpdatableProperties | papi-dts
    WebViewDefinitionUpdatableProperties: Pick<WebViewDefinitionBase, "iconUrl" | "title" | "tooltip">

    The properties on a WebViewDefinition that may be updated when that webview is already displayed

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html index 5f9b8fd991..9a0b1f490a 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html @@ -1,3 +1,3 @@ WebViewDefinitionUpdateInfo | papi-dts
    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html index 669b6e0818..76791deaff 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html @@ -1,2 +1,2 @@ WebViewId | papi-dts
    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html index 36e1fc8fca..5e68b48548 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -35,4 +35,4 @@

    @example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html index f39c696025..a2837373ca 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html @@ -1,2 +1,2 @@ WebViewType | papi-dts
    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index 94d51ca21e..a53ef34112 100644 --- a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html +++ b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html @@ -1,4 +1,4 @@ moduleSummaryComments | papi-dts
    moduleSummaryComments: {}

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -

    Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html index b1d40ea3bc..759ee93def 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html @@ -2,21 +2,21 @@

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html index dafc82d6f2..708db54ebe 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html @@ -1 +1 @@ -MenuDataDataTypes | papi-dts
      MenuDataDataTypes: {
          MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
          WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
      }

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +MenuDataDataTypes | papi-dts
      MenuDataDataTypes: {
          MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
          WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
      }

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html index 3601347b78..e62ba3a303 100644 --- a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html @@ -2,4 +2,4 @@ the spread of the contents array of the request as its parameters. The function should return an object that becomes the contents object of the response. This type of handler is a normal function.

      -

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html index e856b1a28d..2cd7b02505 100644 --- a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html @@ -2,4 +2,4 @@ accept a ComplexRequest object as its single parameter. The function should return a ComplexResponse object that becomes the response.. This type of handler is the most flexible of the request handlers.

      -

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html index 62d09f3c13..4d7beb2770 100644 --- a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html @@ -1,4 +1,4 @@ ContentsRequestHandler | papi-dts

      Type alias ContentsRequestHandler<TParam, TReturn>

      ContentsRequestHandler<TParam, TReturn>: ((contents) => Promise<TReturn>)

      Contents handler function for a request. Called when a request is handled. The function should accept the contents object of the request as its single parameter. The function should return an object that becomes the contents object of the response.

      -

      Type Parameters

      • TParam = any

      • TReturn = any

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html index c769405559..21b4175a0b 100644 --- a/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html @@ -12,4 +12,4 @@ function) to determine if they should be included.

      Defaults to all ProjectTypes, so all projects that do not match excludeProjectTypes will be included

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html index 8c2c220c02..de13ff00aa 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html @@ -1,3 +1,3 @@ AllProjectSettingsValidators | papi-dts
      AllProjectSettingsValidators: {
          [ProjectSettingName in ProjectSettingNames]: ProjectSettingValidator<ProjectSettingName>
      }

      Validators for all project settings. Keys are setting keys, values are functions to validate new settings

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html index cd55a9e0a1..4c86d1e3a6 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html @@ -1,2 +1,2 @@ ProjectSettingValidator | papi-dts

      Type alias ProjectSettingValidator<ProjectSettingName>

      ProjectSettingValidator<ProjectSettingName>: ((newValue, currentValue, allChanges, projectType) => Promise<boolean>)

      Function that validates whether a new project setting value should be allowed to be set

      -

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html index f362a5bf62..4566d0acbc 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html @@ -1,4 +1,4 @@ SimultaneousProjectSettingsChanges | papi-dts
      SimultaneousProjectSettingsChanges: {
          [ProjectSettingName in ProjectSettingNames]?: {
              currentValue: ProjectSettingTypes[ProjectSettingName];
              newValue: ProjectSettingTypes[ProjectSettingName];
          }
      }

      All project settings changes being set in one batch

      Project settings may be circularly dependent on one another, so multiple project settings may need to be changed at once in some cases

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html index 02c4ee225a..466e57739d 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html @@ -1 +1 @@ -AllSettingsData | papi-dts
      AllSettingsData: {
          [SettingName in SettingNames]: SettingTypes[SettingName]
      }

      Generated using TypeDoc

      \ No newline at end of file +AllSettingsData | papi-dts
      AllSettingsData: {
          [SettingName in SettingNames]: SettingTypes[SettingName]
      }

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html index bf957ce504..4652954769 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html @@ -1,2 +1,2 @@ AllSettingsValidators | papi-dts
      AllSettingsValidators: {
          [SettingName in SettingNames]: SettingValidator<SettingName>
      }

      Validators for all settings. Keys are setting keys, values are functions to validate new settings

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html index bbf0cf84fd..cdc467386a 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html +++ b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html @@ -3,23 +3,23 @@

      Returns Promise<SettingTypes[SettingName]>

      The value of the specified setting, parsed to an object. Returns default setting if setting does not exist

      Throws

      If no default value is available for the setting.

      -
    • registerValidator:function
    • registerValidator:function
    • reset:function
    • reset:function
    • set:function
    • set:function
    • subscribe:function
    • subscribe:function
    • Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html index 11de28a07e..6a5151d31e 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html @@ -9,4 +9,4 @@

      The closest possible representation of the unnamed (````) data type follows:

      '': DataProviderDataType<SettingName, SettingTypes[SettingName], SettingTypes[SettingName]>;
       
      -

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html index 765343bbc7..c99fef0e2f 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html @@ -1,2 +1,2 @@ SettingValidator | papi-dts
      SettingValidator<SettingName>: ((newValue, currentValue, allChanges) => Promise<boolean>)

      Function that validates whether a new setting value should be allowed to be set

      -

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexRequest.html b/papi-dts/types/_shared_utils_util_.ComplexRequest.html index 8d204ad152..af08da5581 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexRequest.html +++ b/papi-dts/types/_shared_utils_util_.ComplexRequest.html @@ -1,4 +1,4 @@ ComplexRequest | papi-dts

      Type alias ComplexRequest<TParam>

      ComplexRequest<TParam>: {
          contents: TParam;
          senderId: number;
      }

      Type of object passed to a complex request handler that provides information about the request. This type is used as the public-facing interface for requests

      Type Parameters

      • TParam = unknown

      Type declaration

      • contents: TParam
      • senderId: number

        The one who sent the request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponse.html b/papi-dts/types/_shared_utils_util_.ComplexResponse.html index d4adcf987c..49ada58a8f 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponse.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponse.html @@ -1,4 +1,4 @@ ComplexResponse | papi-dts

      Type alias ComplexResponse<TReturn>

      Type of object to create when handling a complex request where you desire to provide additional information beyond the contents of the response This type is used as the public-facing interface for responses

      -

      Type Parameters

      • TReturn = unknown

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html index f006d85628..dbeb46c67b 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html @@ -1,3 +1,3 @@ ComplexResponseFailure | papi-dts

      Type alias ComplexResponseFailure

      ComplexResponseFailure: {
          errorMessage: string;
          success: false;
      }

      Type declaration

      • errorMessage: string

        Error explaining the problem that is only populated if success is false

      • success: false

        Whether the handler that created this response was successful in handling the request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html index 3939263a7f..a9ef9e1cd9 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html @@ -1,4 +1,4 @@ ComplexResponseSuccess | papi-dts

      Type alias ComplexResponseSuccess<TReturn>

      ComplexResponseSuccess<TReturn>: {
          contents: TReturn;
          success: true;
      }

      Type Parameters

      • TReturn = unknown

      Type declaration

      • contents: TReturn

        Content with which to respond to the request. Must be provided unless the response failed or TReturn is undefined

      • success: true

        Whether the handler that created this response was successful in handling the request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index 1c47412397..5ab7516322 100644 --- a/papi-dts/types/_shared_utils_util_.RequestType.html +++ b/papi-dts/types/_shared_utils_util_.RequestType.html @@ -1,4 +1,4 @@ RequestType | papi-dts
      RequestType: {
          category: string;
          directive: string;
      }

      Information about a request that tells us what to do with it

      Type declaration

      • category: string

        The general category of request

      • directive: string

        Specific identifier for this type of request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index de2f019762..8d53adc8ad 100644 --- a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html +++ b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html @@ -1,3 +1,3 @@ SerializedRequestType | papi-dts

      Type alias SerializedRequestType

      SerializedRequestType: `${string}${typeof REQUEST_TYPE_SEPARATOR}${string}`

      String version of a request type that tells us what to do with a request.

      Consists of two strings concatenated by a colon

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index 3c5149ab28..a032fa5398 100644 --- a/papi-dts/variables/__papi_backend_.DataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.DataProviderEngine.html @@ -2,4 +2,4 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

      See

      IDataProviderEngine for more information on extending this class.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html index 643ecaed1b..f04d3103d5 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -8,4 +8,4 @@ If a Project Data Provider Engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

      See

      IProjectDataProviderEngine for more information on extending this class.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index 68cd15ad16..9c6615f1fd 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

      Variable commandsConst

      The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index c9f8a79484..95e91af2bb 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

      Variable dataProvidersConst

      dataProviders: DataProviderService

      Service that allows extensions to send and receive data to/from other extensions

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index 29e9acbd06..472bfdaa78 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -33,4 +33,4 @@
    • webViews: WebViewServiceType

      Service exposing various functions related to using webViews

      WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

      -
    • Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index 5a11099396..44891da50b 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

      Variable dialogsConst

      dialogs: DialogService

      Prompt the user for responses with dialogs

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index 393a388345..01fede5c7b 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

      Variable internetConst

      internet: InternetService

      Service that provides a way to call fetch since the original function is not available

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index 586831484f..06a189645c 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

      Variable loggerConst

      logger: MainLogger & {
          default: MainLogger;
      }

      All extensions and services should use this logger to provide a unified output of logs

      -

      Type declaration

      • default: MainLogger

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index 3857a738dd..b270a7d6fe 100644 --- a/papi-dts/variables/__papi_backend_.menuData.html +++ b/papi-dts/variables/__papi_backend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

      Variable menuDataConst

      Service that allows to get and store menu data

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index 946b1847c1..2dd16c44ba 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

      Variable networkConst

      Service that provides a way to send and receive network events

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index 33d1c39470..29d1f455e7 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

      Variable projectDataProvidersConst

      Service that registers and gets project data providers

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index b343090d29..7bf4d904ec 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

      Variable projectLookupConst

      Provides metadata for projects known by the platform

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectSettings.html b/papi-dts/variables/__papi_backend_.projectSettings.html index bb613b21ac..bdc41759dc 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,3 +1,3 @@ projectSettings | papi-dts

      Variable projectSettingsConst

      projectSettings: IProjectSettingsService

      Provides utility functions that project storage interpreters should call when handling project settings

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 6ba29a79c4..1da23b5f01 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

      Variable storageConst

      This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index cf03b90179..3ad4c9b0a5 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,2 +1,2 @@ webViewProviders | papi-dts

      Variable webViewProvidersConst

      webViewProviders: PapiWebViewProviderService

      Interface for registering webView providers

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 6559ad24ea..6815185d61 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

      Variable webViewsConst

      Service exposing various functions related to using webViews

      WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 2d648e63cf..53347d5b2c 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

      Variable defaultConst

      default: {}

      Exporting empty object so people don't have to put 'type' in their import statements

      -

      Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index 53fedc7369..64ea8393bc 100644 --- a/papi-dts/variables/__papi_frontend_.WebSocket.html +++ b/papi-dts/variables/__papi_frontend_.WebSocket.html @@ -2,4 +2,4 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

        Note that the Node WebSocket implementation is different and not wrapped here.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index 2ab2f673cd..6da2cda3ce 100644 --- a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html +++ b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html @@ -2,4 +2,4 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

        Note that Node doesn't have a native implementation, so this is only for the renderer.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index 57e3b3cedf..7b4be0bcb9 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

        Variable commandsConst

        The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index bdefdfd707..5e10b25378 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

        Variable dataProvidersConst

        dataProviders: DataProviderService

        Service that allows extensions to send and receive data to/from other extensions

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index 2ee89be324..aa1c03cc4a 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -22,4 +22,4 @@
      • settings: ISettingsService
      • webViews: WebViewServiceType

        Service exposing various functions related to using webViews

        WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index d915f12344..3d8de5bf44 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

        Variable dialogsConst

        dialogs: DialogService

        Prompt the user for responses with dialogs

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index 0541fb3a05..e196b5c542 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

        Variable internetConst

        internet: InternetService

        Service that provides a way to call fetch since the original function is not available

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index 1121a66f1b..49a44b6111 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

        Variable loggerConst

        logger: MainLogger & {
            default: MainLogger;
        }

        All extensions and services should use this logger to provide a unified output of logs

        -

        Type declaration

        • default: MainLogger

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index 6ab5a1fa9f..a996cbef16 100644 --- a/papi-dts/variables/__papi_frontend_.menuData.html +++ b/papi-dts/variables/__papi_frontend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

        Variable menuDataConst

        Service that allows to get and store menu data

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index d5911a45e2..789bb70b08 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

        Variable networkConst

        Service that provides a way to send and receive network events

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 1aba5cb615..f93042e727 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

        Variable projectDataProvidersConst

        Service that registers and gets project data providers

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index 3e73c2a370..0f44c29436 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

        Variable projectLookupConst

        Provides metadata for projects known by the platform

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 5cc6874d52..c70e104384 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

        Variable reactConst

        React hooks that enable interacting with the papi in React components more easily.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index c29cc84202..41989c7608 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +settings | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index 185dffa0a5..cf68ebe711 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

        Variable webViewsConst

        Service exposing various functions related to using webViews

        WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html index e9d7aabb2c..ebfc15f895 100644 --- a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html +++ b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html @@ -1,4 +1,4 @@ default | papi-dts

        This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_services_execution_token_service_.default.html b/papi-dts/variables/_node_services_execution_token_service_.default.html index d6c816cf60..5267b7c8c5 100644 --- a/papi-dts/variables/_node_services_execution_token_service_.default.html +++ b/papi-dts/variables/_node_services_execution_token_service_.default.html @@ -1 +1 @@ -default | papi-dts
        default: {
            registerExtension: typeof registerExtension;
            tokenIsValid: typeof tokenIsValid;
            unregisterExtension: typeof unregisterExtension;
        }

        Type declaration

        • registerExtension: typeof registerExtension
        • tokenIsValid: typeof tokenIsValid
        • unregisterExtension: typeof unregisterExtension

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts
        default: {
            registerExtension: typeof registerExtension;
            tokenIsValid: typeof tokenIsValid;
            unregisterExtension: typeof unregisterExtension;
        }

        Type declaration

        • registerExtension: typeof registerExtension
        • tokenIsValid: typeof tokenIsValid
        • unregisterExtension: typeof unregisterExtension

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index e7fdd07154..296186b340 100644 --- a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html @@ -1 +1 @@ -FILE_PROTOCOL | papi-dts

        Variable FILE_PROTOCOLConst

        FILE_PROTOCOL: "file://" = 'file://'

        Generated using TypeDoc

        \ No newline at end of file +FILE_PROTOCOL | papi-dts

        Variable FILE_PROTOCOLConst

        FILE_PROTOCOL: "file://" = 'file://'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index f5d7730bd2..c4bb2c8563 100644 --- a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html @@ -1 +1 @@ -RESOURCES_PROTOCOL | papi-dts

        Variable RESOURCES_PROTOCOLConst

        RESOURCES_PROTOCOL: "resources://" = 'resources://'

        Generated using TypeDoc

        \ No newline at end of file +RESOURCES_PROTOCOL | papi-dts

        Variable RESOURCES_PROTOCOLConst

        RESOURCES_PROTOCOL: "resources://" = 'resources://'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html index c18541f15c..08081c5754 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html @@ -5,4 +5,4 @@ we would not be able to use the default loadDialog because it would be using a static reference to a nonexistent Component. Instead of inheriting this as a class, any dialog definition can spread this { ...DIALOG_BASE }

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html index 74a055d3db..84cbafffa0 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE | papi-dts
        SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE: "platform.selectMultipleProjects" = 'platform.selectMultipleProjects'

        The tabType for the select multiple projects dialog in select-multiple-projects.dialog.tsx

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html index 5d24239f46..bedd0014df 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_PROJECT_DIALOG_TYPE | papi-dts
        SELECT_PROJECT_DIALOG_TYPE: "platform.selectProject" = 'platform.selectProject'

        The tabType for the select project dialog in select-project.dialog.tsx

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html index 77fee9ba9f..2e8f0fd01d 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html @@ -1,2 +1,2 @@ CATEGORY_COMMAND | papi-dts
        CATEGORY_COMMAND: "command" = 'command'

        Prefix on requests that indicates that the request is a command

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html index 8ae31f3035..8be854e1cc 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html @@ -1,2 +1,2 @@ CLIENT_ID_SERVER | papi-dts
        CLIENT_ID_SERVER: 0 = 0

        "Client id" for the server

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html index 87ee1dc7b2..4512b9b736 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html @@ -1,2 +1,2 @@ CLIENT_ID_UNASSIGNED | papi-dts
        CLIENT_ID_UNASSIGNED: -1 = -1

        Represents when the client id has not been assigned by the server

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html index 652100129c..7212a2aa04 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html @@ -1,2 +1,2 @@ CONNECTOR_INFO_DISCONNECTED | papi-dts
        CONNECTOR_INFO_DISCONNECTED: Readonly<{
            clientId: -1;
        }>

        Represents when the connector info has not been populated by the server

        -

        Type declaration

        • clientId: -1

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html index de57e2e138..2c00517e75 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html @@ -1,2 +1,2 @@ WEBSOCKET_ATTEMPTS_MAX | papi-dts
        WEBSOCKET_ATTEMPTS_MAX: 5 = 5

        Number of attempts a client will make to connect to the WebSocket server before failing

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html index 46b6c1e3b7..81f52e7fee 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html @@ -1,3 +1,3 @@ WEBSOCKET_ATTEMPTS_WAIT | papi-dts
        WEBSOCKET_ATTEMPTS_WAIT: 1000 = 1000

        Time in ms for the client to wait before attempting to connect to the WebSocket server again after a failure

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html index 3057c2ea99..e1a8688928 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html @@ -1,2 +1,2 @@ WEBSOCKET_PORT | papi-dts
        WEBSOCKET_PORT: 8876 = 8876

        Port to use for the webSocket

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_data_provider_service_.default.html b/papi-dts/variables/_shared_services_data_provider_service_.default.html index 794e43203d..ff8897123b 100644 --- a/papi-dts/variables/_shared_services_data_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_data_provider_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

        Service that allows extensions to send and receive data to/from other extensions

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 73ea881dc6..0d99ba876e 100644 --- a/papi-dts/variables/_shared_services_dialog_service_.default.html +++ b/papi-dts/variables/_shared_services_dialog_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html index dec32a0e8a..9e5637d627 100644 --- a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html +++ b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html @@ -1,2 +1,2 @@ CATEGORY_DIALOG | papi-dts
        CATEGORY_DIALOG: "dialog" = 'dialog'

        Prefix on requests that indicates that the request is related to dialog operations

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index 643ac9e292..40b92b503e 100644 --- a/papi-dts/variables/_shared_services_internet_service_.default.html +++ b/papi-dts/variables/_shared_services_internet_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

        Service that provides a way to call fetch since the original function is not available

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html index 3eb1952a9f..1aaca2a20a 100644 --- a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html +++ b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html @@ -1 +1 @@ -WARN_TAG | papi-dts
        WARN_TAG: "<WARN>" = '<WARN>'

        Generated using TypeDoc

        \ No newline at end of file +WARN_TAG | papi-dts
        WARN_TAG: "<WARN>" = '<WARN>'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index 422bb87781..489768ddb6 100644 --- a/papi-dts/variables/_shared_services_logger_service_.default.html +++ b/papi-dts/variables/_shared_services_logger_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts
        default: log.MainLogger & {
            default: log.MainLogger;
        }

        All extensions and services should use this logger to provide a unified output of logs

        -

        Type declaration

        • default: log.MainLogger

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_.default.html b/papi-dts/variables/_shared_services_menu_data_service_.default.html index 7df0f95b8f..c0949c65a4 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_.default.html +++ b/papi-dts/variables/_shared_services_menu_data_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html index a5023e0deb..396025a2ca 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html @@ -1,3 +1,3 @@ menuDataServiceObjectToProxy | papi-dts
        menuDataServiceObjectToProxy: Readonly<{
            dataProviderName: "platform.menuDataServiceDataProvider";
        }>

        Type declaration

        • dataProviderName: "platform.menuDataServiceDataProvider"

          This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html index 27dc6661f8..3119af2f95 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html @@ -1,3 +1,3 @@ menuDataServiceProviderName | papi-dts
        menuDataServiceProviderName: "platform.menuDataServiceDataProvider" = 'platform.menuDataServiceDataProvider'

        This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_service_.default.html b/papi-dts/variables/_shared_services_network_object_service_.default.html index 2ecd491497..6a3b4d514c 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_service_.default.html @@ -18,4 +18,4 @@

        When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_.default.html b/papi-dts/variables/_shared_services_network_object_status_service_.default.html index fe70fa5349..40d6690b6b 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index 7f9f889d1a..2ba6461522 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts
        networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

        Generated using TypeDoc

        \ No newline at end of file +networkObjectStatusServiceNetworkObjectName | papi-dts
        networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index 765e3157f3..b85e557ca0 100644 --- a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html +++ b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html @@ -1,2 +1,2 @@ papiNetworkService | papi-dts
        papiNetworkService: PapiNetworkService

        Service that provides a way to send and receive network events

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html index dfec7b4ec1..f65e0f43a7 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiBackendProjectDataProviderService | papi-dts
        papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

        Service that registers and gets project data providers

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html index 3fb7dbc175..c382777a30 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiFrontendProjectDataProviderService | papi-dts
        papiFrontendProjectDataProviderService: {
            get: typeof get;
        }

        Service that gets project data providers

        -

        Type declaration

        • get: typeof get

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_.default.html b/papi-dts/variables/_shared_services_project_lookup_service_.default.html index bac2ec09ee..f2f78cece0 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_.default.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html index 6ae14fbae9..266efe1d75 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html @@ -1 +1 @@ -projectLookupServiceNetworkObjectName | papi-dts
        projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

        Generated using TypeDoc

        \ No newline at end of file +projectLookupServiceNetworkObjectName | papi-dts
        projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_.default.html b/papi-dts/variables/_shared_services_project_settings_service_.default.html index 9b0a52a92d..8ca2a13071 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_project_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html index 6f6ec4b6a3..c84b0b2dc7 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR | papi-dts
        CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR: "extensionProjectSettingValidator" = 'extensionProjectSettingValidator'

        Name prefix for registered commands that call project settings validators

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html index 9f98dd3f92..ebeb6acc64 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html @@ -1 +1 @@ -projectSettingsServiceNetworkObjectName | papi-dts
        projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

        Generated using TypeDoc

        \ No newline at end of file +projectSettingsServiceNetworkObjectName | papi-dts
        projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html index f67ad2f6f7..5e8206b50a 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html @@ -6,4 +6,4 @@

        Returns

        Unsubscriber that should be called whenever the providing ext

        Type Parameters

        Parameters

        Returns Promise<UnsubscriberAsync>

        Unsubscriber that should be called whenever the providing extension is deactivated

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index c1933c11a7..cb75eec5d4 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html index 5618b0b700..6f298d24bd 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_SETTING_VALIDATOR | papi-dts
        CATEGORY_EXTENSION_SETTING_VALIDATOR: "extensionSettingValidator" = 'extensionSettingValidator'

        Name prefix for registered commands that call settings validators

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html index 98ce7d4ddc..1da16a2822 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html @@ -1,3 +1,3 @@ settingsServiceDataProviderName | papi-dts
        settingsServiceDataProviderName: "platform.settingsServiceDataProvider" = 'platform.settingsServiceDataProvider'

        This name is used to register the settings service data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html index b09c8fab16..068e0219e0 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html @@ -8,4 +8,4 @@

        Returns

        Unsubscriber that should be called whenever the providing ext

        Type Parameters

        Parameters

        Returns Promise<UnsubscriberAsync>

        Unsubscriber that should be called whenever the providing extension is deactivated

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html index cc3ff351a4..860fa2627b 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html index bebd39b2de..39cb66a8f4 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html @@ -1,2 +1,2 @@ papiWebViewProviderService | papi-dts
        papiWebViewProviderService: PapiWebViewProviderService

        Interface for registering webView providers

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_.default.html b/papi-dts/variables/_shared_services_web_view_service_.default.html index aea678ba21..ee80bbe9db 100644 --- a/papi-dts/variables/_shared_services_web_view_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html index 7fb2440970..e73b678f0c 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_ADD_WEB_VIEW | papi-dts
        EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

        Name to use when creating a network event that is fired when webViews are created

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html index f89b864958..d2cac6ac5d 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
        NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

        Generated using TypeDoc

        \ No newline at end of file +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
        NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html index a4781f307f..e78f72890b 100644 --- a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html +++ b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html @@ -1,3 +1,3 @@ MODULE_SIMILAR_APIS | papi-dts

        Variable MODULE_SIMILAR_APISConst

        MODULE_SIMILAR_APIS: Readonly<{
            [moduleName: string]: string | {
                [process in ProcessType | "default"]?: string
            } | undefined;
        }>

        Modules that someone might try to require in their extensions that we have similar apis for. When an extension requires these modules, an error throws that lets them know about our similar api.

        -

        Type declaration

        • [moduleName: string]: string | {
              [process in ProcessType | "default"]?: string
          } | undefined

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html index 56f885b0f3..9b20006cab 100644 --- a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html +++ b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html @@ -1,2 +1,2 @@ REQUEST_TYPE_SEPARATOR | papi-dts

        Variable REQUEST_TYPE_SEPARATORConst

        REQUEST_TYPE_SEPARATOR: ":" = ':'

        Separator between parts of a serialized request

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index fae22f2f25..87cfd13b86 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

        Variable isPackaged

        isPackaged: boolean

        Whether this process is packaged or running from sources

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 473e9801fe..ab6a0f668b 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

        Variable logLevel

        logLevel: LogLevel

        How much logging should be recorded. Defaults to 'debug' if not packaged, 'info' if packaged

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index a7b714f05b..0d8cf73c16 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

        Variable processType

        processType: ProcessType

        Type of process this is. Helps with running specific code based on which process you're in

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index 0500bbd558..3fca0c7d0e 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

        Variable resourcesPath

        resourcesPath: string

        Path to the app's resources directory. This is a string representation of the resources uri on frontend

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/enums/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index de9fcc2c73..e3f04d5b02 100644 --- a/platform-bible-react/enums/LabelPosition.html +++ b/platform-bible-react/enums/LabelPosition.html @@ -1,5 +1,5 @@ -LabelPosition | platform-bible-react

        Enumeration LabelPosition

        Enumeration Members

        Above +LabelPosition | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Enumeration Members

        Above: "above"
        After: "after"
        Before: "before"
        Below: "below"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index 1200d97126..474e38ec79 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ Button | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index f73e33896e..7436466510 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

        Function ChapterRangeSelector

        Generated using TypeDoc

        \ No newline at end of file +ChapterRangeSelector | platform-bible-react

        Function ChapterRangeSelector

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index a97fc25c84..bfe8dbe268 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,2 +1,2 @@ Checkbox | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index c701422253..583746ec1a 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/ContextMenu.html b/platform-bible-react/functions/ContextMenu.html index b0c5d4c846..ec1977d0a5 100644 --- a/platform-bible-react/functions/ContextMenu.html +++ b/platform-bible-react/functions/ContextMenu.html @@ -4,4 +4,4 @@ component which define what menu items to display and supply a command handler for when a menu item is clicked.

        Returns undefined | null | string | number | boolean | Iterable<ReactNode> | Element

        The ContextMenu component (including the wrapped children)

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index 0b9e519c10..4b52615046 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +GridMenu | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index 8e3ae5abca..46d7549f3c 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

        Function HamburgerMenuButton

        Generated using TypeDoc

        \ No newline at end of file +HamburgerMenuButton | platform-bible-react

        Function HamburgerMenuButton

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index af8d8f3eca..86f566a0aa 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 734bd9561f..9f5f24c15a 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +MenuItem | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/RefSelector.html b/platform-bible-react/functions/RefSelector.html index 3d83c57ea2..e9aeae6e40 100644 --- a/platform-bible-react/functions/RefSelector.html +++ b/platform-bible-react/functions/RefSelector.html @@ -1 +1 @@ -RefSelector | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +RefSelector | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index 34aeb5f009..5845cd4e91 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +SearchBar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index 4e85ef16b0..281f53be16 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ Slider | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Snackbar.html b/platform-bible-react/functions/Snackbar.html index 65721dfae7..d856c79938 100644 --- a/platform-bible-react/functions/Snackbar.html +++ b/platform-bible-react/functions/Snackbar.html @@ -1,4 +1,4 @@ Snackbar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index 171c947928..92967f9beb 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ Switch | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index 2361b5378f..e5f17434bb 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ Table | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index 95461b988c..b36666ce5f 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index ff1c017789..52a173956c 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +Toolbar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index 694270cc75..82504c9a8d 100644 --- a/platform-bible-react/functions/useEvent.html +++ b/platform-bible-react/functions/useEvent.html @@ -9,4 +9,4 @@
      • eventHandler: PlatformEventHandler<T>

        The callback to run when the event is emitted

        WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

        -
      • Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index 83ddf05c86..cfd4f13821 100644 --- a/platform-bible-react/functions/useEventAsync.html +++ b/platform-bible-react/functions/useEventAsync.html @@ -10,4 +10,4 @@
      • eventHandler: PlatformEventHandler<T>

        The callback to run when the event is emitted

        WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

        -
      • Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index 8f5fb03f78..f06ea60106 100644 --- a/platform-bible-react/functions/usePromise.html +++ b/platform-bible-react/functions/usePromise.html @@ -21,4 +21,4 @@
      • value: the current value for the promise, either the defaultValue or the resolved promise value
      • isLoading: whether the promise is waiting to be resolved
      • -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index d35e1dfb6f..4c0ab2a286 100644 --- a/platform-bible-react/interfaces/CommandHandler.html +++ b/platform-bible-react/interfaces/CommandHandler.html @@ -1 +1 @@ -CommandHandler | platform-bible-react

        Interface CommandHandler

        interface CommandHandler ((command) => void)

        Generated using TypeDoc

        \ No newline at end of file +CommandHandler | platform-bible-react

        Interface CommandHandler

        interface CommandHandler ((command) => void)

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index 78c8d83395..73aa1090e9 100644 --- a/platform-bible-react/interfaces/MultiColumnMenuProvider.html +++ b/platform-bible-react/interfaces/MultiColumnMenuProvider.html @@ -1 +1 @@ -MultiColumnMenuProvider | platform-bible-react

        Interface MultiColumnMenuProvider

        interface MultiColumnMenuProvider ((isSupportAndDevelopment) => Promise<{
            columns: {
                isExtensible?: boolean;
            };
            groups: {};
            items: ({
                group: string;
                id: string;
                label: string;
                localizeNotes: string;
                order: number;
                searchTerms?: string;
                tooltip?: string;
            } | {
                command: string;
                group: string;
                iconPathAfter?: string;
                iconPathBefore?: string;
                label: string;
                localizeNotes: string;
                order: number;
                searchTerms?: string;
                tooltip?: string;
            })[];
        }>)
        • Parameters

          • isSupportAndDevelopment: boolean

          Returns Promise<{
              columns: {
                  isExtensible?: boolean;
              };
              groups: {};
              items: ({
                  group: string;
                  id: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              } | {
                  command: string;
                  group: string;
                  iconPathAfter?: string;
                  iconPathBefore?: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              })[];
          }>

        Generated using TypeDoc

        \ No newline at end of file +MultiColumnMenuProvider | platform-bible-react

        Interface MultiColumnMenuProvider

        interface MultiColumnMenuProvider ((isSupportAndDevelopment) => Promise<{
            columns: {
                isExtensible?: boolean;
            };
            groups: {};
            items: ({
                group: string;
                id: string;
                label: string;
                localizeNotes: string;
                order: number;
                searchTerms?: string;
                tooltip?: string;
            } | {
                command: string;
                group: string;
                iconPathAfter?: string;
                iconPathBefore?: string;
                label: string;
                localizeNotes: string;
                order: number;
                searchTerms?: string;
                tooltip?: string;
            })[];
        }>)
        • Parameters

          • isSupportAndDevelopment: boolean

          Returns Promise<{
              columns: {
                  isExtensible?: boolean;
              };
              groups: {};
              items: ({
                  group: string;
                  id: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              } | {
                  command: string;
                  group: string;
                  iconPathAfter?: string;
                  iconPathBefore?: string;
                  label: string;
                  localizeNotes: string;
                  order: number;
                  searchTerms?: string;
                  tooltip?: string;
              })[];
          }>

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/ScrRefSelectorProps.html b/platform-bible-react/interfaces/ScrRefSelectorProps.html index 75ecd95f15..526566b84c 100644 --- a/platform-bible-react/interfaces/ScrRefSelectorProps.html +++ b/platform-bible-react/interfaces/ScrRefSelectorProps.html @@ -1,4 +1,4 @@ -ScrRefSelectorProps | platform-bible-react

        Interface ScrRefSelectorProps

        interface ScrRefSelectorProps {
            handleSubmit: ((scrRef) => void);
            id?: string;
            scrRef: ScriptureReference;
        }

        Properties

        handleSubmit +ScrRefSelectorProps | platform-bible-react

        Interface ScrRefSelectorProps

        interface ScrRefSelectorProps {
            handleSubmit: ((scrRef) => void);
            id?: string;
            scrRef: ScriptureReference;
        }

        Properties

        Properties

        handleSubmit: ((scrRef) => void)

        Type declaration

          • (scrRef): void
          • Parameters

            • scrRef: ScriptureReference

            Returns void

        id?: string
        scrRef: ScriptureReference

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        handleSubmit: ((scrRef) => void)

        Type declaration

          • (scrRef): void
          • Parameters

            • scrRef: ScriptureReference

            Returns void

        id?: string
        scrRef: ScriptureReference

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/TableCalculatedColumn.html b/platform-bible-react/interfaces/TableCalculatedColumn.html index 654a4578ef..bb78e99736 100644 --- a/platform-bible-react/interfaces/TableCalculatedColumn.html +++ b/platform-bible-react/interfaces/TableCalculatedColumn.html @@ -1,4 +1,4 @@ -TableCalculatedColumn | platform-bible-react

        Interface TableCalculatedColumn<R>

        interface TableCalculatedColumn<R> {
            draggable: boolean;
            editable?: null | boolean | ((row) => boolean);
            frozen: boolean;
            idx: number;
            isLastFrozenColumn: boolean;
            key: string;
            level: number;
            maxWidth: undefined | number;
            minWidth: number;
            name: string | ReactElement<any, string | JSXElementConstructor<any>>;
            parent: undefined | TableCalculatedColumnParent<R>;
            renderCell: ((props) => ReactNode);
            renderEditCell?: null | ((props) => ReactNode);
            resizable: boolean;
            sortDescendingFirst?: null | boolean;
            sortable: boolean;
            width: string | number;
        }

        Type Parameters

        • R

        Hierarchy (view full)

        Properties

        draggable +TableCalculatedColumn | platform-bible-react

        Interface TableCalculatedColumn<R>

        interface TableCalculatedColumn<R> {
            draggable: boolean;
            editable?: null | boolean | ((row) => boolean);
            frozen: boolean;
            idx: number;
            isLastFrozenColumn: boolean;
            key: string;
            level: number;
            maxWidth: undefined | number;
            minWidth: number;
            name: string | ReactElement<any, string | JSXElementConstructor<any>>;
            parent: undefined | TableCalculatedColumnParent<R>;
            renderCell: ((props) => ReactNode);
            renderEditCell?: null | ((props) => ReactNode);
            resizable: boolean;
            sortDescendingFirst?: null | boolean;
            sortable: boolean;
            width: string | number;
        }

        Type Parameters

        • R

        Hierarchy (view full)

        Properties

        draggable: boolean
        editable?: null | boolean | ((row) => boolean)

        If true, editing is enabled. If no custom cell editor is provided through renderEditCell +

        Properties

        draggable: boolean
        editable?: null | boolean | ((row) => boolean)

        If true, editing is enabled. If no custom cell editor is provided through renderEditCell the default text editor will be used for editing. Note: If editable is set to 'true' and no custom renderEditCell is provided, the internal logic that sets the renderEditCell will shallow clone the column.

        -

        Type declaration

          • (row): boolean
          • Parameters

            • row: R

            Returns boolean

        frozen: boolean
        idx: number
        isLastFrozenColumn: boolean
        key: string

        A unique key to distinguish each column

        -
        level: number
        maxWidth: undefined | number
        minWidth: number
        name: string | ReactElement<any, string | JSXElementConstructor<any>>

        The name of the column. By default it will be displayed in the header cell

        -
        parent: undefined | TableCalculatedColumnParent<R>
        renderCell: ((props) => ReactNode)

        Type declaration

          • (props): ReactNode
          • Parameters

            • props: RenderCellProps<R, unknown>

            Returns ReactNode

        renderEditCell?: null | ((props) => ReactNode)

        Editor to be rendered when cell of column is being edited. Don't forget to also set the +

        Type declaration

          • (row): boolean
          • Parameters

            • row: R

            Returns boolean

        frozen: boolean
        idx: number
        isLastFrozenColumn: boolean
        key: string

        A unique key to distinguish each column

        +
        level: number
        maxWidth: undefined | number
        minWidth: number
        name: string | ReactElement<any, string | JSXElementConstructor<any>>

        The name of the column. By default it will be displayed in the header cell

        +
        parent: undefined | TableCalculatedColumnParent<R>
        renderCell: ((props) => ReactNode)

        Type declaration

          • (props): ReactNode
          • Parameters

            • props: RenderCellProps<R, unknown>

            Returns ReactNode

        renderEditCell?: null | ((props) => ReactNode)

        Editor to be rendered when cell of column is being edited. Don't forget to also set the editable prop to true in order to enable editing.

        -

        Type declaration

        resizable: boolean
        sortDescendingFirst?: null | boolean

        Sets the column sort order to be descending instead of ascending the first time the column is +

        Type declaration

        resizable: boolean
        sortDescendingFirst?: null | boolean

        Sets the column sort order to be descending instead of ascending the first time the column is sorted

        -
        sortable: boolean
        width: string | number

        Generated using TypeDoc

        \ No newline at end of file +
        sortable: boolean
        width: string | number

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/AnchorOrigin.html b/platform-bible-react/types/AnchorOrigin.html index ca1c60f0d1..367129228e 100644 --- a/platform-bible-react/types/AnchorOrigin.html +++ b/platform-bible-react/types/AnchorOrigin.html @@ -1 +1 @@ -AnchorOrigin | platform-bible-react

        Type alias AnchorOrigin

        AnchorOrigin: SnackbarOrigin

        Generated using TypeDoc

        \ No newline at end of file +AnchorOrigin | platform-bible-react

        Type alias AnchorOrigin

        AnchorOrigin: SnackbarOrigin

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ButtonProps.html b/platform-bible-react/types/ButtonProps.html index ff9ea08e30..d78cf3e6be 100644 --- a/platform-bible-react/types/ButtonProps.html +++ b/platform-bible-react/types/ButtonProps.html @@ -5,4 +5,4 @@
      • Optional onClick?: MouseEventHandler<HTMLButtonElement>

        Optional click handler

      • Optional onContextMenu?: MouseEventHandler<HTMLButtonElement>

        Optional context menu handler

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 12901723a1..2ec1abfebf 100644 --- a/platform-bible-react/types/ChapterRangeSelectorProps.html +++ b/platform-bible-react/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | platform-bible-react

        Type alias ChapterRangeSelectorProps

        ChapterRangeSelectorProps: {
            chapterCount: number;
            endChapter: number;
            handleSelectEndChapter: ((chapter) => void);
            handleSelectStartChapter: ((chapter) => void);
            isDisabled?: boolean;
            startChapter: number;
        }

        Type declaration

        • chapterCount: number
        • endChapter: number
        • handleSelectEndChapter: ((chapter) => void)
            • (chapter): void
            • Parameters

              • chapter: number

              Returns void

        • handleSelectStartChapter: ((chapter) => void)
            • (chapter): void
            • Parameters

              • chapter: number

              Returns void

        • Optional isDisabled?: boolean
        • startChapter: number

        Generated using TypeDoc

        \ No newline at end of file +ChapterRangeSelectorProps | platform-bible-react

        Type alias ChapterRangeSelectorProps

        ChapterRangeSelectorProps: {
            chapterCount: number;
            endChapter: number;
            handleSelectEndChapter: ((chapter) => void);
            handleSelectStartChapter: ((chapter) => void);
            isDisabled?: boolean;
            startChapter: number;
        }

        Type declaration

        • chapterCount: number
        • endChapter: number
        • handleSelectEndChapter: ((chapter) => void)
            • (chapter): void
            • Parameters

              • chapter: number

              Returns void

        • handleSelectStartChapter: ((chapter) => void)
            • (chapter): void
            • Parameters

              • chapter: number

              Returns void

        • Optional isDisabled?: boolean
        • startChapter: number

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/CheckboxProps.html b/platform-bible-react/types/CheckboxProps.html index 6491587b00..6ccc16ee68 100644 --- a/platform-bible-react/types/CheckboxProps.html +++ b/platform-bible-react/types/CheckboxProps.html @@ -25,4 +25,4 @@

        Parameters

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/CloseReason.html b/platform-bible-react/types/CloseReason.html index 2e3c314902..1fbc63cc5d 100644 --- a/platform-bible-react/types/CloseReason.html +++ b/platform-bible-react/types/CloseReason.html @@ -1 +1 @@ -CloseReason | platform-bible-react

        Type alias CloseReason

        CloseReason: SnackbarCloseReason

        Generated using TypeDoc

        \ No newline at end of file +CloseReason | platform-bible-react

        Type alias CloseReason

        CloseReason: SnackbarCloseReason

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeDetails.html b/platform-bible-react/types/ComboBoxChangeDetails.html index 9060dadcea..8729d95846 100644 --- a/platform-bible-react/types/ComboBoxChangeDetails.html +++ b/platform-bible-react/types/ComboBoxChangeDetails.html @@ -1 +1 @@ -ComboBoxChangeDetails | platform-bible-react

        Type alias ComboBoxChangeDetails<T>

        ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

        Type Parameters

        • T

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxChangeDetails | platform-bible-react

        Type alias ComboBoxChangeDetails<T>

        ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

        Type Parameters

        • T

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeReason.html b/platform-bible-react/types/ComboBoxChangeReason.html index 8ee7d54848..5592c77440 100644 --- a/platform-bible-react/types/ComboBoxChangeReason.html +++ b/platform-bible-react/types/ComboBoxChangeReason.html @@ -1 +1 @@ -ComboBoxChangeReason | platform-bible-react

        Type alias ComboBoxChangeReason

        ComboBoxChangeReason: AutocompleteChangeReason

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxChangeReason | platform-bible-react

        Type alias ComboBoxChangeReason

        ComboBoxChangeReason: AutocompleteChangeReason

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index e17248c47f..bdff2866a0 100644 --- a/platform-bible-react/types/ComboBoxLabelOption.html +++ b/platform-bible-react/types/ComboBoxLabelOption.html @@ -1 +1 @@ -ComboBoxLabelOption | platform-bible-react

        Type alias ComboBoxLabelOption

        ComboBoxLabelOption: {
            label: string;
        }

        Type declaration

        • label: string

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxLabelOption | platform-bible-react

        Type alias ComboBoxLabelOption

        ComboBoxLabelOption: {
            label: string;
        }

        Type declaration

        • label: string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index 5c91b3d3fa..260e6b1103 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxOption | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index c9ff72ba05..e95aa931c7 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -23,4 +23,4 @@
      • Optional value?: T

        The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

      • Optional width?: number

        Width of the combobox in pixels. Setting this prop overrides the isFullWidth prop

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxValue.html b/platform-bible-react/types/ComboBoxValue.html index 086e50cda8..7a29b2ee70 100644 --- a/platform-bible-react/types/ComboBoxValue.html +++ b/platform-bible-react/types/ComboBoxValue.html @@ -1 +1 @@ -ComboBoxValue | platform-bible-react

        Type alias ComboBoxValue<T, X, Y, Z>

        ComboBoxValue<T, X, Y, Z>: AutocompleteValue<T, X, Y, Z>

        Type Parameters

        • T

        • X

        • Y

        • Z

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxValue | platform-bible-react

        Type alias ComboBoxValue<T, X, Y, Z>

        ComboBoxValue<T, X, Y, Z>: AutocompleteValue<T, X, Y, Z>

        Type Parameters

        • T

        • X

        • Y

        • Z

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index 77ad08fafa..dada91ebf9 100644 --- a/platform-bible-react/types/GridMenuInfo.html +++ b/platform-bible-react/types/GridMenuInfo.html @@ -1,2 +1,2 @@ GridMenuInfo | platform-bible-react

        Type alias GridMenuInfo

        GridMenuInfo: {
            multiColumnMenu: Localized<MultiColumnMenu>;
        }

        Type declaration

        • multiColumnMenu: Localized<MultiColumnMenu>

          The menu object containing information about the columns, groups, and items to display.

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index f5dc2222fa..3220ea526d 100644 --- a/platform-bible-react/types/GridMenuProps.html +++ b/platform-bible-react/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | platform-bible-react

        Type alias GridMenuProps

        GridMenuProps: GridMenuInfo & {
            className?: string;
            commandHandler: CommandHandler;
            id?: string;
        }

        Type declaration

        • Optional className?: string

          Additional css classes to help with unique styling of the grid menu

        • commandHandler: CommandHandler
        • Optional id?: string

          Optional unique identifier

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index 0c9dc7a1d4..342157d3c2 100644 --- a/platform-bible-react/types/IconButtonProps.html +++ b/platform-bible-react/types/IconButtonProps.html @@ -16,4 +16,4 @@

        Default

        false
         
      • Optional tooltip?: string

        Optional tooltip to display if different from the aria-label.

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index 21631a7f09..27989274fc 100644 --- a/platform-bible-react/types/MenuItemListProps.html +++ b/platform-bible-react/types/MenuItemListProps.html @@ -1,2 +1,2 @@ MenuItemListProps | platform-bible-react

        Type alias MenuItemListProps

        MenuItemListProps: MenuPropsBase & {
            columnId?: ReferencedItem;
        }

        Type declaration

        • Optional columnId?: ReferencedItem

          Optional unique (column) identifier

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index fe7055415f..9def6a50b7 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -2,4 +2,4 @@
      • onSearch: ((searchQuery) => void)

        Callback fired to handle the search query when button pressed

        Param: searchQuery

      • Optional placeholder?: string

        Optional string that appears in the search bar without a search string

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SliderProps.html b/platform-bible-react/types/SliderProps.html index f864df25ef..369220bad8 100644 --- a/platform-bible-react/types/SliderProps.html +++ b/platform-bible-react/types/SliderProps.html @@ -49,4 +49,4 @@

        Param: value

        The new value.

        Default

        'off'
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarContentProps.html b/platform-bible-react/types/SnackbarContentProps.html index 2094d2a59a..205d2b6507 100644 --- a/platform-bible-react/types/SnackbarContentProps.html +++ b/platform-bible-react/types/SnackbarContentProps.html @@ -1,4 +1,4 @@ SnackbarContentProps | platform-bible-react

        Type alias SnackbarContentProps

        SnackbarContentProps: {
            action?: ReactNode;
            className?: string;
            message?: ReactNode;
        }

        Type declaration

        • Optional action?: ReactNode

          The action to display, renders after the message

        • Optional className?: string

          Additional css classes to help with unique styling of the snackbar, internal

        • Optional message?: ReactNode

          The message to display

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarProps.html b/platform-bible-react/types/SnackbarProps.html index 76f058a321..f87a5ff792 100644 --- a/platform-bible-react/types/SnackbarProps.html +++ b/platform-bible-react/types/SnackbarProps.html @@ -14,4 +14,4 @@ string

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SwitchProps.html b/platform-bible-react/types/SwitchProps.html index 6143122a5d..b1aca7351b 100644 --- a/platform-bible-react/types/SwitchProps.html +++ b/platform-bible-react/types/SwitchProps.html @@ -15,4 +15,4 @@

        Parameters

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellClickArgs.html b/platform-bible-react/types/TableCellClickArgs.html index 59df53755a..c3ed84fd6a 100644 --- a/platform-bible-react/types/TableCellClickArgs.html +++ b/platform-bible-react/types/TableCellClickArgs.html @@ -1 +1 @@ -TableCellClickArgs | platform-bible-react

        Type alias TableCellClickArgs<R>

        TableCellClickArgs<R>: CellClickArgs<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TableCellClickArgs | platform-bible-react

        Type alias TableCellClickArgs<R>

        TableCellClickArgs<R>: CellClickArgs<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyDownArgs.html b/platform-bible-react/types/TableCellKeyDownArgs.html index d6462c4d77..5c36dffa92 100644 --- a/platform-bible-react/types/TableCellKeyDownArgs.html +++ b/platform-bible-react/types/TableCellKeyDownArgs.html @@ -1 +1 @@ -TableCellKeyDownArgs | platform-bible-react

        Type alias TableCellKeyDownArgs<R>

        TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TableCellKeyDownArgs | platform-bible-react

        Type alias TableCellKeyDownArgs<R>

        TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyboardEvent.html b/platform-bible-react/types/TableCellKeyboardEvent.html index 5874785298..ac7dc37772 100644 --- a/platform-bible-react/types/TableCellKeyboardEvent.html +++ b/platform-bible-react/types/TableCellKeyboardEvent.html @@ -1 +1 @@ -TableCellKeyboardEvent | platform-bible-react

        Type alias TableCellKeyboardEvent

        TableCellKeyboardEvent: CellKeyboardEvent

        Generated using TypeDoc

        \ No newline at end of file +TableCellKeyboardEvent | platform-bible-react

        Type alias TableCellKeyboardEvent

        TableCellKeyboardEvent: CellKeyboardEvent

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellMouseEvent.html b/platform-bible-react/types/TableCellMouseEvent.html index f4c45d5c8f..4d7267f0bd 100644 --- a/platform-bible-react/types/TableCellMouseEvent.html +++ b/platform-bible-react/types/TableCellMouseEvent.html @@ -1 +1 @@ -TableCellMouseEvent | platform-bible-react

        Type alias TableCellMouseEvent

        TableCellMouseEvent: CellMouseEvent

        Generated using TypeDoc

        \ No newline at end of file +TableCellMouseEvent | platform-bible-react

        Type alias TableCellMouseEvent

        TableCellMouseEvent: CellMouseEvent

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableColumn.html b/platform-bible-react/types/TableColumn.html index 84e818eb7c..a3a0b18db5 100644 --- a/platform-bible-react/types/TableColumn.html +++ b/platform-bible-react/types/TableColumn.html @@ -15,4 +15,4 @@
      • Optional Readonly sortable?: boolean

        Enable sorting of a column

      • Optional Readonly width?: number | string

        Column width. If not specified, it will be determined automatically based on grid width and specified widths of other columns

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCopyEvent.html b/platform-bible-react/types/TableCopyEvent.html index 444d4259bf..a2202436e5 100644 --- a/platform-bible-react/types/TableCopyEvent.html +++ b/platform-bible-react/types/TableCopyEvent.html @@ -1 +1 @@ -TableCopyEvent | platform-bible-react

        Type alias TableCopyEvent<R>

        TableCopyEvent<R>: CopyEvent<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TableCopyEvent | platform-bible-react

        Type alias TableCopyEvent<R>

        TableCopyEvent<R>: CopyEvent<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableEditorProps.html b/platform-bible-react/types/TableEditorProps.html index fbabad3ce0..b261c84b42 100644 --- a/platform-bible-react/types/TableEditorProps.html +++ b/platform-bible-react/types/TableEditorProps.html @@ -1 +1 @@ -TableEditorProps | platform-bible-react

        Type alias TableEditorProps<R>

        TableEditorProps<R>: {
            column: TableCalculatedColumn<R>;
            onClose: ((commitChanges?) => void);
            onRowChange: ((row, commitChanges?) => void);
            row: R;
        }

        Type Parameters

        • R

        Type declaration

        • column: TableCalculatedColumn<R>
        • onClose: ((commitChanges?) => void)
            • (commitChanges?): void
            • Parameters

              • Optional commitChanges: boolean

              Returns void

        • onRowChange: ((row, commitChanges?) => void)
            • (row, commitChanges?): void
            • Parameters

              • row: R
              • Optional commitChanges: boolean

              Returns void

        • row: R

        Generated using TypeDoc

        \ No newline at end of file +TableEditorProps | platform-bible-react

        Type alias TableEditorProps<R>

        TableEditorProps<R>: {
            column: TableCalculatedColumn<R>;
            onClose: ((commitChanges?) => void);
            onRowChange: ((row, commitChanges?) => void);
            row: R;
        }

        Type Parameters

        • R

        Type declaration

        • column: TableCalculatedColumn<R>
        • onClose: ((commitChanges?) => void)
            • (commitChanges?): void
            • Parameters

              • Optional commitChanges: boolean

              Returns void

        • onRowChange: ((row, commitChanges?) => void)
            • (row, commitChanges?): void
            • Parameters

              • row: R
              • Optional commitChanges: boolean

              Returns void

        • row: R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TablePasteEvent.html b/platform-bible-react/types/TablePasteEvent.html index fd74c2c72c..a547beef59 100644 --- a/platform-bible-react/types/TablePasteEvent.html +++ b/platform-bible-react/types/TablePasteEvent.html @@ -1 +1 @@ -TablePasteEvent | platform-bible-react

        Type alias TablePasteEvent<R>

        TablePasteEvent<R>: PasteEvent<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TablePasteEvent | platform-bible-react

        Type alias TablePasteEvent<R>

        TablePasteEvent<R>: PasteEvent<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableProps.html b/platform-bible-react/types/TableProps.html index cc200e6b7e..e0293b7292 100644 --- a/platform-bible-react/types/TableProps.html +++ b/platform-bible-react/types/TableProps.html @@ -74,4 +74,4 @@

        Param: width

        The new width of the column in pixels

      • Optional selectedRows?: ReadonlySet<Key>

        A set of keys representing the currently selected rows

      • Optional sortColumns?: readonly TableSortColumn[]

        An array of objects representing the currently sorted columns

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableRowsChangeData.html b/platform-bible-react/types/TableRowsChangeData.html index 2d24d03741..45af783cc9 100644 --- a/platform-bible-react/types/TableRowsChangeData.html +++ b/platform-bible-react/types/TableRowsChangeData.html @@ -1 +1 @@ -TableRowsChangeData | platform-bible-react

        Type alias TableRowsChangeData<R>

        TableRowsChangeData<R>: RowsChangeData<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TableRowsChangeData | platform-bible-react

        Type alias TableRowsChangeData<R>

        TableRowsChangeData<R>: RowsChangeData<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableSortColumn.html b/platform-bible-react/types/TableSortColumn.html index fa3e8fe5d9..9dede72d41 100644 --- a/platform-bible-react/types/TableSortColumn.html +++ b/platform-bible-react/types/TableSortColumn.html @@ -1 +1 @@ -TableSortColumn | platform-bible-react

        Type alias TableSortColumn

        TableSortColumn: SortColumn

        Generated using TypeDoc

        \ No newline at end of file +TableSortColumn | platform-bible-react

        Type alias TableSortColumn

        TableSortColumn: SortColumn

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index 678a8de387..c2e4930c97 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -23,4 +23,4 @@
      • Optional variant?: "outlined" | "filled"

        The variant to use.

        Default

        'outlined'
         
        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index 83494fde91..deed62ffac 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
      • Optional id?: string

        Optional unique identifier

      • Optional menuProvider?: MultiColumnMenuProvider

        The optional delegate to use to get the menu data. If not specified, the "hamburger" menu will not display.

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index 04463c9e51..99be15e103 100644 --- a/platform-bible-react/types/UsePromiseOptions.html +++ b/platform-bible-react/types/UsePromiseOptions.html @@ -1,3 +1,3 @@ UsePromiseOptions | platform-bible-react

        Type alias UsePromiseOptions

        UsePromiseOptions: {
            preserveValue?: boolean;
        }

        Type declaration

        • Optional preserveValue?: boolean

          Whether to leave the value as the most recent resolved promise value or set it back to defaultValue while running the promise again. Defaults to true

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index 82285482d1..79272f4905 100644 --- a/platform-bible-utils/classes/AsyncVariable.html +++ b/platform-bible-utils/classes/AsyncVariable.html @@ -1,5 +1,5 @@ AsyncVariable | platform-bible-utils

        Class AsyncVariable<T>

        This class provides a convenient way for one task to wait on a variable that another task sets.

        -

        Type Parameters

        • T

        Constructors

        Type Parameters

        • T

        Constructors

        Properties

        promiseToValue rejecter resolver @@ -14,18 +14,18 @@
      • rejectIfNotSettledWithinMS: number = 10000

        Milliseconds to wait before verifying if the promise was settled (resolved or rejected); will reject if it has not settled by that time. Use -1 if you do not want a timeout at all.

        -
      • Returns AsyncVariable<T>

        Properties

        promiseToValue: Promise<T>
        rejecter: undefined | ((reason) => void)

        Type declaration

          • (reason): void
          • Parameters

            • reason: undefined | string

            Returns void

        resolver: undefined | ((value) => void)

        Type declaration

          • (value): void
          • Parameters

            • value: T

            Returns void

        variableName: string

        Accessors

        • get hasSettled(): boolean
        • A simple way to see if this variable's promise was resolved or rejected already

          +

        Returns AsyncVariable<T>

        Properties

        promiseToValue: Promise<T>
        rejecter: undefined | ((reason) => void)

        Type declaration

          • (reason): void
          • Parameters

            • reason: undefined | string

            Returns void

        resolver: undefined | ((value) => void)

        Type declaration

          • (value): void
          • Parameters

            • value: T

            Returns void

        variableName: string

        Accessors

        • get promise(): Promise<T>
        • Get this variable's promise to a value. This always returns the same promise even after the value has been resolved or rejected.

          Returns Promise<T>

          The promise for the value to be set

          -

        Methods

        Methods

        • Reject this variable's promise for the value with the given reason

          Parameters

          • reason: string

            This variable's promise will be rejected with this reason

          • throwIfAlreadySettled: boolean = false

            Determines whether to throw if the variable was already resolved or rejected

            -

          Returns void

        • Resolve this variable's promise to the given value

          +

        Returns void

        • Resolve this variable's promise to the given value

          Parameters

          • value: T

            This variable's promise will resolve to this value

          • throwIfAlreadySettled: boolean = false

            Determines whether to throw if the variable was already resolved or rejected

            -

          Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index 17df7297f4..7843a27498 100644 --- a/platform-bible-utils/classes/DocumentCombiner.html +++ b/platform-bible-utils/classes/DocumentCombiner.html @@ -1,6 +1,6 @@ DocumentCombiner | platform-bible-utils

        Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

        -

        Hierarchy (view full)

        Constructors

        Hierarchy (view full)

        Constructors

        Properties

        Constructors

        Properties

        baseDocument: JsonDocumentLike
        contributions: Map<string, JsonDocumentLike> = ...
        latestOutput: undefined | JsonDocumentLike
        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        -
        onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

        Methods

        • Add or update one of the contribution documents for the composition process

          +

        Returns DocumentCombiner

        Properties

        baseDocument: JsonDocumentLike
        contributions: Map<string, JsonDocumentLike> = ...
        latestOutput: undefined | JsonDocumentLike
        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        +
        onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

        Methods

        • Add or update one of the contribution documents for the composition process

          Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -33,22 +33,22 @@

        • document: JsonDocumentLike

          Content of the contributed document to combine

        Returns undefined | JsonDocumentLike

        Recalculated output document given the new or updated contribution and existing other documents

        -
        • Transform the starting document that is given to the combiner. This transformation occurs after validating the base document and before combining any contributions.

          WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the baseDocument passed in.

          Parameters

          • baseDocument: JsonDocumentLike

            Initial input document. Already validated via validateBaseDocument

          Returns JsonDocumentLike

          Transformed base document

          -
        • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

          WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

          @@ -56,19 +56,19 @@
        • document: JsonDocumentLike

          Content of the contributed document to combine. Already validated via validateContribution

        Returns JsonDocumentLike

        Transformed contributed document

        -

        Returns JsonDocumentLike

        Returns void

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index 439c6976d4..ddf553fd8f 100644 --- a/platform-bible-utils/classes/Mutex.html +++ b/platform-bible-utils/classes/Mutex.html @@ -3,7 +3,7 @@

        Example

        const mutex = new Mutex();

        mutex.runExclusive(async () => {
        // Do some asynchronous stuff
        console.log('These run one-at-a-time');
        });

        mutex.runExclusive(async () => {
        // Do some asynchronous stuff
        console.log('These run one-at-a-time');
        });

        See async-mutex for more information.

        -

        Hierarchy

        Constructors

        Hierarchy

        • Mutex
          • Mutex

        Constructors

        Methods

        acquire cancel isLocked diff --git a/platform-bible-utils/classes/MutexMap.html b/platform-bible-utils/classes/MutexMap.html index 6b6f6556ad..3b4294fd41 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,5 +1,5 @@ MutexMap | platform-bible-utils

        Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

        -

        Constructors

        Constructors

        Properties

        Methods

        get -

        Constructors

        Properties

        mutexesByID: Map<string, Mutex> = ...

        Methods

        Generated using TypeDoc

        \ No newline at end of file +

        Constructors

        Properties

        mutexesByID: Map<string, Mutex> = ...

        Methods

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index c679a1f1f7..f994e76c8c 100644 --- a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html +++ b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html @@ -1,6 +1,6 @@ NonValidatingDocumentCombiner | platform-bible-utils

        Class NonValidatingDocumentCombiner

        Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

        -

        Hierarchy (view full)

        Constructors

        Hierarchy (view full)

        Constructors

        Properties

        baseDocument: JsonDocumentLike
        contributions: Map<string, JsonDocumentLike> = ...
        latestOutput: undefined | JsonDocumentLike
        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        -

        Accessors

        Methods

        • Add or update one of the contribution documents for the composition process

          +

        Constructors

        Properties

        baseDocument: JsonDocumentLike
        contributions: Map<string, JsonDocumentLike> = ...
        latestOutput: undefined | JsonDocumentLike
        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        +

        Accessors

        Methods

        • Add or update one of the contribution documents for the composition process

          Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -30,22 +30,22 @@

        • document: JsonDocumentLike

          Content of the contributed document to combine

        Returns undefined | JsonDocumentLike

        Recalculated output document given the new or updated contribution and existing other documents

        -
        • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

          WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

          @@ -53,19 +53,19 @@
        • document: JsonDocumentLike

          Content of the contributed document to combine. Already validated via validateContribution

        Returns JsonDocumentLike

        Transformed contributed document

        -
        • Update the starting document for composition process

          +

        Returns JsonDocumentLike

        • Throw an error if the provided document is not a valid contribution document.

          +

        Returns void

        • Throw an error if the provided output is not valid.

          +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index 03ef6219b8..0bd2c2c11f 100644 --- a/platform-bible-utils/classes/PlatformEventEmitter.html +++ b/platform-bible-utils/classes/PlatformEventEmitter.html @@ -3,7 +3,7 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

        -

        Type Parameters

        Implements

        Constructors

        Type Parameters

        • T

        Implements

        Constructors

        Properties

        Constructors

        Properties

        isDisposed: boolean = false

        Whether this emitter has been disposed

        -
        lazyEvent?: PlatformEvent<T>

        Event for listeners to subscribe to. Lazy loaded

        -
        subscribe: PlatformEvent<T> = ...

        Subscribes a function to run when this event is emitted.

        +
        lazyEvent?: PlatformEvent<T>

        Event for listeners to subscribe to. Lazy loaded

        +
        subscribe: PlatformEvent<T> = ...

        Subscribes a function to run when this event is emitted.

        Param: callback

        Function to run with the event when it is emitted

        Returns

        Unsubscriber function to run to stop calling the passed-in function when the event is emitted

        Alias

        event

        -
        subscriptions?: PlatformEventHandler<T>[]

        All callback functions that will run when this event is emitted. Lazy loaded

        -

        Accessors

        subscriptions?: PlatformEventHandler<T>[]

        All callback functions that will run when this event is emitted. Lazy loaded

        +

        Accessors

        Methods

        Methods

        • Function that runs the subscriptions for the event. Added here so children can override emit +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index 559644565d..2ece9e9006 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,11 +1,11 @@ UnsubscriberAsyncList | platform-bible-utils

        Simple collection for UnsubscriberAsync objects that also provides an easy way to run them.

        -

        Constructors

        Constructors

        Properties

        Methods

        Constructors

        Properties

        name: string = 'Anonymous'
        unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

        Methods

        • Add unsubscribers to the list. Note that duplicates are not added twice.

          +

        Constructors

        Properties

        name: string = 'Anonymous'
        unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

        Methods

        • Run all unsubscribers added to this list and then clear the list.

          +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index ab71d08d82..2d023314df 100644 --- a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html +++ b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html @@ -1,4 +1,4 @@ aggregateUnsubscriberAsyncs | platform-bible-utils

        Function aggregateUnsubscriberAsyncs

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index 1b64dfdde3..560023962c 100644 --- a/platform-bible-utils/functions/aggregateUnsubscribers.html +++ b/platform-bible-utils/functions/aggregateUnsubscribers.html @@ -1,4 +1,4 @@ aggregateUnsubscribers | platform-bible-utils

        Function aggregateUnsubscribers

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index a179795824..f510938b2f 100644 --- a/platform-bible-utils/functions/at.html +++ b/platform-bible-utils/functions/at.html @@ -6,4 +6,4 @@ length(string)

        Returns string | undefined

        New string consisting of the Unicode code point located at the specified offset, undefined if index is out of bounds

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index d1c271119e..264b04fb56 100644 --- a/platform-bible-utils/functions/charAt.html +++ b/platform-bible-utils/functions/charAt.html @@ -6,4 +6,4 @@ length(string)-1

        Returns string

        New string consisting of the Unicode code point located at the specified offset, empty string if index is out of bounds

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index e92751653b..3b6dc317f4 100644 --- a/platform-bible-utils/functions/codePointAt.html +++ b/platform-bible-utils/functions/codePointAt.html @@ -7,4 +7,4 @@ length(string)-1

        Returns number | undefined

        Non-negative integer representing the code point value of the character at the given index, or undefined if there is no element at that position

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index 32f328d803..a7eda402c5 100644 --- a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html +++ b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html @@ -7,4 +7,4 @@ does not exist on this object, it will be considered to be an asynchronous method called on the object returned from getObject.

        Returns T

        A synchronous proxy for the asynchronous object.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index 2e972d9980..6bcff91707 100644 --- a/platform-bible-utils/functions/debounce.html +++ b/platform-bible-utils/functions/debounce.html @@ -3,4 +3,4 @@
      • delay: number = 300

        How much delay in milliseconds after the most recent call to the debounced function to call the function

      • Returns T

        Function that, when called, only calls the function passed in at maximum every delay ms

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index eff3031ea3..5668721320 100644 --- a/platform-bible-utils/functions/deepClone.html +++ b/platform-bible-utils/functions/deepClone.html @@ -2,4 +2,4 @@ references between the source and target of property copying operations.

        Type Parameters

        Parameters

        Returns T

        Duplicate copy of obj without any references back to the original one

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index 7d33ead20b..71aa6171ad 100644 --- a/platform-bible-utils/functions/deepEqual.html +++ b/platform-bible-utils/functions/deepEqual.html @@ -15,4 +15,4 @@ CodeSandbox.

        Returns boolean

        True if a and b are deeply equal; false otherwise

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index 2613daea4c..6b57c9a919 100644 --- a/platform-bible-utils/functions/deserialize.html +++ b/platform-bible-utils/functions/deserialize.html @@ -9,4 +9,4 @@ the object. If a member contains nested objects, the nested objects are transformed before the parent object is. Note that null values are converted into undefined values after the reviver has run.

        -

        Returns any

        Generated using TypeDoc

        \ No newline at end of file +

        Returns any

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index cac2ab0dc3..2fd947ec30 100644 --- a/platform-bible-utils/functions/endsWith.html +++ b/platform-bible-utils/functions/endsWith.html @@ -6,4 +6,4 @@
      • endPosition: number = ...

        End position where searchString is expected to be found. Default is length(string)

      • Returns boolean

        True if it ends with searchString, false if it does not

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index 66ca8473d0..1e1c66f2be 100644 --- a/platform-bible-utils/functions/getAllObjectFunctionNames.html +++ b/platform-bible-utils/functions/getAllObjectFunctionNames.html @@ -5,4 +5,4 @@

        Parameters

        Returns Set<string>

        Array of all function names on an object

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index d9a9a396b3..afa149beef 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        Generated using TypeDoc

        \ No newline at end of file +getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 2300022f6a..bfa520a581 100644 --- a/platform-bible-utils/functions/getErrorMessage.html +++ b/platform-bible-utils/functions/getErrorMessage.html @@ -5,4 +5,4 @@ stringify

        Example

        `try {...} catch (e) { logger.info(getErrorMessage(e)) }`
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index a21cc2eaa7..7576c31b14 100644 --- a/platform-bible-utils/functions/groupBy.html +++ b/platform-bible-utils/functions/groupBy.html @@ -2,4 +2,4 @@

        Type Parameters

        Parameters

        Returns Map<K, T[]>

        Map of keys to groups of values corresponding to each item

        -
      • Type Parameters

        • T

        • K

        • V

        Parameters

        • items: T[]
        • keySelector: ((item) => K)
            • (item): K
            • Parameters

              • item: T

              Returns K

        • valueSelector: ((item, key) => V)
            • (item, key): V
            • Parameters

              • item: T
              • key: K

              Returns V

        Returns Map<K, V[]>

      • Generated using TypeDoc

        \ No newline at end of file +
      • Type Parameters

        • T

        • K

        • V

        Parameters

        • items: T[]
        • keySelector: ((item) => K)
            • (item): K
            • Parameters

              • item: T

              Returns K

        • valueSelector: ((item, key) => V)
            • (item, key): V
            • Parameters

              • item: T
              • key: K

              Returns V

        Returns Map<K, V[]>

      • Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 6110a9e368..ae2418c57a 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index fe491a85ad..6d49020b8e 100644 --- a/platform-bible-utils/functions/includes.html +++ b/platform-bible-utils/functions/includes.html @@ -5,4 +5,4 @@
      • searchString: string

        String to search for

      • position: number = 0

        Position within the string to start searching for searchString. Default is 0

      • Returns boolean

        True if search string is found, false if it is not

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index 2d78640285..d72c3c9caf 100644 --- a/platform-bible-utils/functions/indexOf.html +++ b/platform-bible-utils/functions/indexOf.html @@ -5,4 +5,4 @@
      • searchString: string

        The string to search for

      • position: undefined | number = 0

        Start of searching. Default is 0

      • Returns number

        Index of the first occurrence of a given string

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index 85ff93cfb4..0f688efa1a 100644 --- a/platform-bible-utils/functions/isSerializable.html +++ b/platform-bible-utils/functions/isSerializable.html @@ -13,4 +13,4 @@

        We intend to improve this in the future if it becomes important to do so. See JSON.stringify documentation for more information.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index d05a83a4d8..037ab79048 100644 --- a/platform-bible-utils/functions/isString.html +++ b/platform-bible-utils/functions/isString.html @@ -1,4 +1,4 @@ isString | platform-bible-utils
        • Determine whether the object is a string

          Parameters

          • o: unknown

            Object to determine if it is a string

          Returns o is string

          True if the object is a string; false otherwise

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index 6ae0d1b8ce..d401bbc535 100644 --- a/platform-bible-utils/functions/lastIndexOf.html +++ b/platform-bible-utils/functions/lastIndexOf.html @@ -6,4 +6,4 @@
      • Optional position: number

        The index at which to begin searching. If omitted, the search begins at the end of the string. Default is undefined

      • Returns number

        Index of the last occurrence of searchString found, or -1 if not found.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index ab2d36119d..1d8f1ea5d2 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file +

        Returns string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index 5f95fd777f..39021e3256 100644 --- a/platform-bible-utils/functions/normalize.html +++ b/platform-bible-utils/functions/normalize.html @@ -4,4 +4,4 @@

        Parameters

        Returns string

        A string containing the Unicode Normalization Form of the given string.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index fead13832a..74c7aebb28 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file +offsetBook | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index 32f9f74528..8a2e8b0a8d 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

        Function offsetChapter

        Generated using TypeDoc

        \ No newline at end of file +offsetChapter | platform-bible-utils

        Function offsetChapter

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index 485955e747..15d685e02a 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file +offsetVerse | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index 9922d269ec..6514df5a36 100644 --- a/platform-bible-utils/functions/padEnd.html +++ b/platform-bible-utils/functions/padEnd.html @@ -8,4 +8,4 @@
      • padString: string = ' '

        The string to pad the current string with. If padString is too long to stay within targetLength, it will be truncated. Default is " "

      • Returns string

        String with appropriate padding at the end

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index aff14862e8..edbc08218b 100644 --- a/platform-bible-utils/functions/padStart.html +++ b/platform-bible-utils/functions/padStart.html @@ -8,4 +8,4 @@
      • padString: string = ' '

        The string to pad the current string with. If padString is too long to stay within the targetLength, it will be truncated from the end. Default is " "

      • Returns string

        String with of specified targetLength with padString applied from the start

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 0208438fa6..2f732993b5 100644 --- a/platform-bible-utils/functions/serialize.html +++ b/platform-bible-utils/functions/serialize.html @@ -10,4 +10,4 @@
      • Optional space: string | number

        Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read. See the space parameter of JSON.stringify for more details.

        -
      • Returns string

        Generated using TypeDoc

        \ No newline at end of file +

        Returns string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index f1bfcec2c0..7b7792c561 100644 --- a/platform-bible-utils/functions/slice.html +++ b/platform-bible-utils/functions/slice.html @@ -6,4 +6,4 @@
      • indexStart: number

        The index of the first character to include in the returned substring.

      • Optional indexEnd: number

        The index of the first character to exclude from the returned substring.

      • Returns string

        A new string containing the extracted section of the string.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index 2b329e933e..e4106198ae 100644 --- a/platform-bible-utils/functions/split.html +++ b/platform-bible-utils/functions/split.html @@ -9,4 +9,4 @@ in the array.

        Returns string[]

        An array of strings, split at each point where separator occurs in the starting string. Returns undefined if separator is not found in string.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index ed99c0c98d..2caa49dbcd 100644 --- a/platform-bible-utils/functions/startsWith.html +++ b/platform-bible-utils/functions/startsWith.html @@ -8,4 +8,4 @@ searchString's first character). Default is 0

        Returns boolean

        True if the given characters are found at the beginning of the string, including when searchString is an empty string; otherwise, false.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index 122d8d2667..2d23086453 100644 --- a/platform-bible-utils/functions/stringLength.html +++ b/platform-bible-utils/functions/stringLength.html @@ -4,4 +4,4 @@

        Returns the length of a string.

        Parameters

        Returns number

        Number that is length of the starting string

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index 7e3a492763..f37b917ebf 100644 --- a/platform-bible-utils/functions/substring.html +++ b/platform-bible-utils/functions/substring.html @@ -5,4 +5,4 @@
      • begin: number

        Start position

      • end: number = ...

        End position. Default is End of string

      • Returns string

        Substring from starting string

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index d7301a57bc..bdbb06deec 100644 --- a/platform-bible-utils/functions/toArray.html +++ b/platform-bible-utils/functions/toArray.html @@ -3,4 +3,4 @@

        Converts a string to an array of string characters.

        Parameters

        Returns string[]

        An array of characters from the starting string

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 5ea112fb8e..2a43be14d5 100644 --- a/platform-bible-utils/functions/wait.html +++ b/platform-bible-utils/functions/wait.html @@ -1,2 +1,2 @@ wait | platform-bible-utils
        • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

          -

          Parameters

          • ms: number

          Returns Promise<void>

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Promise<void>

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index 92238b52eb..cde062a457 100644 --- a/platform-bible-utils/functions/waitForDuration.html +++ b/platform-bible-utils/functions/waitForDuration.html @@ -3,4 +3,4 @@
      • maxWaitTimeInMS: number

        The maximum amount of time to wait for the function to resolve

      • Returns Promise<undefined | Awaited<TResult>>

        Promise that resolves to the resolved value of the function or undefined if it ran longer than the specified wait time

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 99473799bc..ed5fad03a4 100644 --- a/platform-bible-utils/interfaces/BookInfo.html +++ b/platform-bible-utils/interfaces/BookInfo.html @@ -1,4 +1,4 @@ -BookInfo | platform-bible-utils
        interface BookInfo {
            chapters: number;
            fullNames: string[];
            shortName: string;
        }

        Properties

        chapters +BookInfo | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        chapters: number
        fullNames: string[]
        shortName: string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index d6c38e142d..117fb7d90a 100644 --- a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html +++ b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | platform-bible-utils

        Interface CannotHaveOnDidDispose

        Indicates than an object cannot have an onDidDispose event. Also allows an object to include a dispose function.

        -
        interface CannotHaveOnDidDispose {
            dispose?: UnsubscriberAsync;
            onDidDispose?: undefined;
        }

        Properties

        interface CannotHaveOnDidDispose {
            dispose?: UnsubscriberAsync;
            onDidDispose?: undefined;
        }

        Properties

        Release resources and notify dependent services when tearing down an object

        -
        onDidDispose?: undefined

        Event that emits when dispose is called on an object

        -

        Generated using TypeDoc

        \ No newline at end of file +
        onDidDispose?: undefined

        Event that emits when dispose is called on an object

        +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index 6ce634d00e..fe31e30253 100644 --- a/platform-bible-utils/interfaces/Dispose.html +++ b/platform-bible-utils/interfaces/Dispose.html @@ -1,4 +1,4 @@ Dispose | platform-bible-utils

        Require a dispose function

        -
        interface Dispose {
            dispose: UnsubscriberAsync;
        }

        Implemented by

        Properties

        interface Dispose {
            dispose: UnsubscriberAsync;
        }

        Implemented by

        Properties

        Properties

        Release resources and notify dependent services when tearing down an object

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index de9b4fae51..354984221f 100644 --- a/platform-bible-utils/interfaces/ModifierExtensionControlled.html +++ b/platform-bible-utils/interfaces/ModifierExtensionControlled.html @@ -1,6 +1,6 @@ ModifierExtensionControlled | platform-bible-utils

        Interface ModifierExtensionControlled

        Modifies state/setting type to be extension-controlled. "Extension-controlled" means the extension provides the component and the validator for the state/setting, so the state/setting is controlled by the extension.

        -
        interface ModifierExtensionControlled {
            platformType?: undefined;
            type?: undefined;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        interface ModifierExtensionControlled {
            platformType?: undefined;
            type?: undefined;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        Properties

        platformType?: undefined
        type?: undefined

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        platformType?: undefined
        type?: undefined

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index 19c08d3f98..0278a3b431 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,11 +1,11 @@ ModifierProject | platform-bible-utils

        Interface ModifierProject

        Modifies setting type to be project setting

        -
        interface ModifierProject {
            excludeProjectTypes?: string | string[];
            includeProjectTypes?: string | string[];
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        interface ModifierProject {
            excludeProjectTypes?: string | string[];
            includeProjectTypes?: string | string[];
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        excludeProjectTypes?: string | string[]

        RegExp pattern to match against projectType to determine if this project setting should absolutely not be displayed in the Project Settings dialog of that projectType even if it matches with includeProjectTypes

        -
        includeProjectTypes?: string | string[]

        RegExp pattern(s) to match against projectType (using the +

        includeProjectTypes?: string | string[]

        RegExp pattern(s) to match against projectType (using the test function) to determine whether this project setting should be displayed in the Project Settings Dialog of that projectType. null means do not show on any Project Settings dialog

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 33ad121620..8db4576bbb 100644 --- a/platform-bible-utils/interfaces/OnDidDispose.html +++ b/platform-bible-utils/interfaces/OnDidDispose.html @@ -1,4 +1,4 @@ OnDidDispose | platform-bible-utils

        Interface OnDidDispose

        Require an onDidDispose event

        -
        interface OnDidDispose {
            onDidDispose: PlatformEvent<void>;
        }

        Properties

        interface OnDidDispose {
            onDidDispose: PlatformEvent<void>;
        }

        Properties

        Properties

        onDidDispose: PlatformEvent<void>

        Event that emits when dispose is called on an object

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 8c321eca2a..d542ba91ea 100644 --- a/platform-bible-utils/interfaces/ProjectSettingProperties.html +++ b/platform-bible-utils/interfaces/ProjectSettingProperties.html @@ -1,2 +1,2 @@ ProjectSettingProperties | platform-bible-utils

        Interface ProjectSettingProperties

        Object whose keys are setting IDs and whose values are settings objects

        -
        interface ProjectSettingProperties {
            [k: ReferencedItem]: ProjectSetting;
        }

        Indexable

        Generated using TypeDoc

        \ No newline at end of file +
        interface ProjectSettingProperties {
            [k: ReferencedItem]: ProjectSetting;
        }

        Indexable

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index a69403f699..1a9d4feecc 100644 --- a/platform-bible-utils/interfaces/ProjectSettingsGroup.html +++ b/platform-bible-utils/interfaces/ProjectSettingsGroup.html @@ -1,7 +1,7 @@ ProjectSettingsGroup | platform-bible-utils

        Interface ProjectSettingsGroup

        Group of related settings definitions

        -
        interface ProjectSettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: ProjectSettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        interface ProjectSettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: ProjectSettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        description?: `%${string}%`

        LocalizeKey that displays in the project settings dialog to describe the group

        -
        label: `%${string}%`

        LocalizeKey that displays in the project settings dialog as the group name

        -

        Generated using TypeDoc

        \ No newline at end of file +
        label: `%${string}%`

        LocalizeKey that displays in the project settings dialog as the group name

        +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 87fd64896f..7a3235b612 100644 --- a/platform-bible-utils/interfaces/ProjectStateContribution.html +++ b/platform-bible-utils/interfaces/ProjectStateContribution.html @@ -1,2 +1,2 @@ ProjectStateContribution | platform-bible-utils

        Interface ProjectStateContribution

        The data an extension provides to inform Platform.Bible of the project state it provides

        -
        interface ProjectStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        Generated using TypeDoc

        \ No newline at end of file +
        interface ProjectStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index 83bb76daf7..cb868467b3 100644 --- a/platform-bible-utils/interfaces/ScriptureReference.html +++ b/platform-bible-utils/interfaces/ScriptureReference.html @@ -1,4 +1,4 @@ -ScriptureReference | platform-bible-utils

        Interface ScriptureReference

        interface ScriptureReference {
            bookNum: number;
            chapterNum: number;
            verseNum: number;
        }

        Properties

        bookNum +ScriptureReference | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        bookNum: number
        chapterNum: number
        verseNum: number

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index a24aa08beb..331e9116bb 100644 --- a/platform-bible-utils/interfaces/SettingProperties.html +++ b/platform-bible-utils/interfaces/SettingProperties.html @@ -1,2 +1,2 @@ SettingProperties | platform-bible-utils

        Interface SettingProperties

        Object whose keys are setting IDs and whose values are settings objects

        -
        interface SettingProperties {
            [k: ReferencedItem]: Setting;
        }

        Indexable

        Generated using TypeDoc

        \ No newline at end of file +
        interface SettingProperties {
            [k: ReferencedItem]: Setting;
        }

        Indexable

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index 3e311d1820..d84642df15 100644 --- a/platform-bible-utils/interfaces/SettingsGroup.html +++ b/platform-bible-utils/interfaces/SettingsGroup.html @@ -1,7 +1,7 @@ SettingsGroup | platform-bible-utils

        Interface SettingsGroup

        Group of related settings definitions

        -
        interface SettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: SettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        interface SettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: SettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        description?: `%${string}%`

        LocalizeKey that displays in the settings dialog to describe the group

        -
        label: `%${string}%`

        LocalizeKey that displays in the settings dialog as the group name

        -
        properties: SettingProperties

        Generated using TypeDoc

        \ No newline at end of file +
        label: `%${string}%`

        LocalizeKey that displays in the settings dialog as the group name

        +
        properties: SettingProperties

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index 30a9e32bfa..247cd46247 100644 --- a/platform-bible-utils/interfaces/StateBase.html +++ b/platform-bible-utils/interfaces/StateBase.html @@ -1,7 +1,7 @@ StateBase | platform-bible-utils

        Base information needed to describe a state entry

        -
        interface StateBase {
            default: unknown;
            derivesFrom?: `${string}.${string}`;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        interface StateBase {
            default: unknown;
            derivesFrom?: `${string}.${string}`;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        default: unknown

        Default value for the state/setting

        -
        derivesFrom?: `${string}.${string}`

        A state/setting ID whose value to set to this state/setting's starting value the first time +

        derivesFrom?: `${string}.${string}`

        A state/setting ID whose value to set to this state/setting's starting value the first time this state/setting is loaded

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index 95c023fc6f..e805b3a6e7 100644 --- a/platform-bible-utils/interfaces/UserStateContribution.html +++ b/platform-bible-utils/interfaces/UserStateContribution.html @@ -1,2 +1,2 @@ UserStateContribution | platform-bible-utils

        Interface UserStateContribution

        The data an extension provides to inform Platform.Bible of the user state it provides

        -
        interface UserStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        Generated using TypeDoc

        \ No newline at end of file +
        interface UserStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index c928da92d4..fe9007cb52 100644 --- a/platform-bible-utils/types/CanHaveOnDidDispose.html +++ b/platform-bible-utils/types/CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | platform-bible-utils

        Type alias CanHaveOnDidDispose<T>

        CanHaveOnDidDispose<T>: Omit<T, "onDidDispose">

        Allow onDidDispose to exist on the type if it was previously disallowed by CannotHaveOnDidDispose

        -

        Type Parameters

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index 16f1810163..78d91c21c0 100644 --- a/platform-bible-utils/types/ColumnsWithHeaders.html +++ b/platform-bible-utils/types/ColumnsWithHeaders.html @@ -1,4 +1,4 @@ ColumnsWithHeaders | platform-bible-utils

        Type alias ColumnsWithHeaders

        ColumnsWithHeaders: {
            isExtensible?: boolean;
            [property: ReferencedItem]: MenuColumnWithHeader;
        }

        Group of columns that can be combined with other columns to form a multi-column menu

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index bf41e5133b..dc57cd874e 100644 --- a/platform-bible-utils/types/DeepPartial.html +++ b/platform-bible-utils/types/DeepPartial.html @@ -1,2 +1,2 @@ DeepPartial | platform-bible-utils

        Type alias DeepPartial<T>

        DeepPartial<T>: T extends object
            ? {
                [P in keyof T]?: DeepPartial<T[P]>
            }
            : T

        Within type T, recursively change all properties to be optional

        -

        Type Parameters

        • T

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index b1dac8b107..f82db7e2ff 100644 --- a/platform-bible-utils/types/DocumentCombinerOptions.html +++ b/platform-bible-utils/types/DocumentCombinerOptions.html @@ -7,4 +7,4 @@ contributed documents. If false, then throw when duplicate properties are seen in contributed documents. -

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index 030eae8f6a..7425155c0c 100644 --- a/platform-bible-utils/types/ExtensionControlledProjectSetting.html +++ b/platform-bible-utils/types/ExtensionControlledProjectSetting.html @@ -1,2 +1,2 @@ ExtensionControlledProjectSetting | platform-bible-utils

        Type alias ExtensionControlledProjectSetting

        ExtensionControlledProjectSetting: ProjectSettingBase & ModifierExtensionControlled

        Setting definition that is validated by the extension.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index d5495875c7..8898eb7bd3 100644 --- a/platform-bible-utils/types/ExtensionControlledSetting.html +++ b/platform-bible-utils/types/ExtensionControlledSetting.html @@ -1,2 +1,2 @@ ExtensionControlledSetting | platform-bible-utils

        Type alias ExtensionControlledSetting

        ExtensionControlledSetting: SettingBase & ModifierExtensionControlled

        Setting definition that is validated by the extension.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index 8f5e66583a..c91247b46a 100644 --- a/platform-bible-utils/types/ExtensionControlledState.html +++ b/platform-bible-utils/types/ExtensionControlledState.html @@ -1,2 +1,2 @@ ExtensionControlledState | platform-bible-utils

        Type alias ExtensionControlledState

        ExtensionControlledState: StateBase & ModifierExtensionControlled

        State definition that is validated by the extension.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index 79a3056bd9..9c5195d1cd 100644 --- a/platform-bible-utils/types/GroupsInMultiColumnMenu.html +++ b/platform-bible-utils/types/GroupsInMultiColumnMenu.html @@ -1,4 +1,4 @@ GroupsInMultiColumnMenu | platform-bible-utils

        Type alias GroupsInMultiColumnMenu

        GroupsInMultiColumnMenu: {
            [property: ReferencedItem]: MenuGroupDetailsInColumn | MenuGroupDetailsInSubMenu;
        }

        Group of menu items that can be combined with other groups to form a single menu/submenu within a multi-column menu. Groups are separated using a line within the menu/submenu.

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index d7d2a592de..54bfb640f3 100644 --- a/platform-bible-utils/types/GroupsInSingleColumnMenu.html +++ b/platform-bible-utils/types/GroupsInSingleColumnMenu.html @@ -1,4 +1,4 @@ GroupsInSingleColumnMenu | platform-bible-utils

        Type alias GroupsInSingleColumnMenu

        GroupsInSingleColumnMenu: {
            [property: ReferencedItem]: OrderedExtensibleContainer | MenuGroupDetailsInSubMenu;
        }

        Group of menu items that can be combined with other groups to form a single context menu/submenu. Groups are separated using a line within the menu/submenu.

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index 241519cb45..be3788b0bf 100644 --- a/platform-bible-utils/types/JsonDocumentLike.html +++ b/platform-bible-utils/types/JsonDocumentLike.html @@ -1 +1 @@ -JsonDocumentLike | platform-bible-utils

        Type alias JsonDocumentLike

        JsonDocumentLike: JsonObjectLike | JsonArrayLike

        Generated using TypeDoc

        \ No newline at end of file +JsonDocumentLike | platform-bible-utils

        Type alias JsonDocumentLike

        JsonDocumentLike: JsonObjectLike | JsonArrayLike

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index bc12dc69b1..46b92e434a 100644 --- a/platform-bible-utils/types/LocalizeKey.html +++ b/platform-bible-utils/types/LocalizeKey.html @@ -1,2 +1,2 @@ LocalizeKey | platform-bible-utils

        Type alias LocalizeKey

        LocalizeKey: `%${string}%`

        Identifier for a string that will be localized in a menu based on the user's UI language

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index 12d68f8068..abeabb82a7 100644 --- a/platform-bible-utils/types/Localized.html +++ b/platform-bible-utils/types/Localized.html @@ -1,3 +1,3 @@ Localized | platform-bible-utils

        Type alias Localized<T>

        Localized<T>: ReplaceType<ReplaceType<T, LocalizeKey, string>, ReferencedItem, string>

        Type that converts any menu type before it is localized to what it is after it is localized. This can be applied to any menu type as needed.

        -

        Type Parameters

        • T

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index 98df64c434..fa40b38bf6 100644 --- a/platform-bible-utils/types/MenuColumnWithHeader.html +++ b/platform-bible-utils/types/MenuColumnWithHeader.html @@ -1,3 +1,3 @@ MenuColumnWithHeader | platform-bible-utils

        Type alias MenuColumnWithHeader

        MenuColumnWithHeader: OrderedExtensibleContainer & {
            label: LocalizeKey;
        }

        Column that includes header text in a menu

        Type declaration

        • label: LocalizeKey

          Key that represents the text of the header text of the column

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index 8e89c4351d..6379a4841b 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInColumn.html +++ b/platform-bible-utils/types/MenuGroupDetailsInColumn.html @@ -1,3 +1,3 @@ MenuGroupDetailsInColumn | platform-bible-utils

        Type alias MenuGroupDetailsInColumn

        MenuGroupDetailsInColumn: OrderedExtensibleContainer & {
            column: ReferencedItem;
        }

        Group of menu items that belongs in a column

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index 5a7637532e..91fb0ea9fa 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html +++ b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html @@ -1,3 +1,3 @@ MenuGroupDetailsInSubMenu | platform-bible-utils

        Type alias MenuGroupDetailsInSubMenu

        MenuGroupDetailsInSubMenu: OrderedExtensibleContainer & {
            menuItem: ReferencedItem;
        }

        Group of menu items that belongs in a submenu

        Type declaration

        • menuItem: ReferencedItem

          ID of menu item hosting the submenu in which this group resides

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index a4a6e7283d..8e3027c551 100644 --- a/platform-bible-utils/types/MenuItemBase.html +++ b/platform-bible-utils/types/MenuItemBase.html @@ -3,4 +3,4 @@
      • localizeNotes: string

        Additional information provided by developers to help people who perform localization

      • Optional searchTerms?: LocalizeKey

        Key that represents words the platform should reference when users are searching for menu items

      • Optional tooltip?: LocalizeKey

        Key that represents the text to display if a mouse pointer hovers over the menu item

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index b290982340..be53a0bfd2 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -2,4 +2,4 @@

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index 56f5a4b047..179bf3bcde 100644 --- a/platform-bible-utils/types/MenuItemContainingSubmenu.html +++ b/platform-bible-utils/types/MenuItemContainingSubmenu.html @@ -1,3 +1,3 @@ MenuItemContainingSubmenu | platform-bible-utils

        Type alias MenuItemContainingSubmenu

        MenuItemContainingSubmenu: MenuItemBase & {
            id: ReferencedItem;
        }

        Menu item that hosts a submenu

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index ef491cf7b7..5710bc4e5e 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index f8986b6fc1..67b52458a0 100644 --- a/platform-bible-utils/types/OrderedExtensibleContainer.html +++ b/platform-bible-utils/types/OrderedExtensibleContainer.html @@ -1,2 +1,2 @@ OrderedExtensibleContainer | platform-bible-utils

        Type alias OrderedExtensibleContainer

        OrderedExtensibleContainer: OrderedItem & {
            isExtensible?: boolean;
        }

        Type declaration

        • Optional isExtensible?: boolean

          Determines whether other items can be added to this after it has been defined

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index 580421b14e..be789873d9 100644 --- a/platform-bible-utils/types/OrderedItem.html +++ b/platform-bible-utils/types/OrderedItem.html @@ -1,2 +1,2 @@ OrderedItem | platform-bible-utils

        Type alias OrderedItem

        OrderedItem: {
            order: number;
        }

        Type declaration

        • order: number

          Relative order of this item compared to other items in the same parent/scope (sorted ascending)

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index a085fc5a15..5789bce520 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

        Type Parameters

        Type declaration

        Returns

        Unsubscriber function to run to stop calling the passed-in function when the event is emitted

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index 05210eacd4..e64270565e 100644 --- a/platform-bible-utils/types/PlatformEventAsync.html +++ b/platform-bible-utils/types/PlatformEventAsync.html @@ -1,3 +1,3 @@ PlatformEventAsync | platform-bible-utils

        Type alias PlatformEventAsync<T>

        PlatformEventAsync<T>: ((callback) => Promise<UnsubscriberAsync>)

        A PapiEvent that subscribes asynchronously and resolves an asynchronous unsubscriber.

        Note: The callback itself is not asynchronous.

        -

        Type Parameters

        • T

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index c7553e207c..cdca403d75 100644 --- a/platform-bible-utils/types/PlatformEventHandler.html +++ b/platform-bible-utils/types/PlatformEventHandler.html @@ -1,2 +1,2 @@ PlatformEventHandler | platform-bible-utils

        Type alias PlatformEventHandler<T>

        PlatformEventHandler<T>: ((event) => void)

        Callback function that accepts an event and should run when an event is emitted

        -

        Type Parameters

        • T

        Type declaration

          • (event): void
          • Parameters

            • event: T

            Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index d4b6de3618..e648ded6c9 100644 --- a/platform-bible-utils/types/PlatformMenus.html +++ b/platform-bible-utils/types/PlatformMenus.html @@ -3,4 +3,4 @@
      • defaultWebViewTopMenu: MultiColumnMenu

        Default top menu for web views that don't specify their own

      • mainMenu: MultiColumnMenu

        Top level menu for the application

      • webViewMenus: WebViewMenus

        Menus that apply per web view in the application

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index 9bf9d7fb67..8132755e9a 100644 --- a/platform-bible-utils/types/ProjectSetting.html +++ b/platform-bible-utils/types/ProjectSetting.html @@ -1,2 +1,2 @@ ProjectSetting | platform-bible-utils

        Type alias ProjectSetting

        A description of an extension's setting entry

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index 91f3f654e6..17a14ae65e 100644 --- a/platform-bible-utils/types/ProjectSettingBase.html +++ b/platform-bible-utils/types/ProjectSettingBase.html @@ -1,2 +1,2 @@ ProjectSettingBase | platform-bible-utils

        Type alias ProjectSettingBase

        ProjectSettingBase: SettingBase & ModifierProject

        Base information needed to describe a project setting entry

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index dccecfb4f9..90a2b998b9 100644 --- a/platform-bible-utils/types/ProjectSettingsContribution.html +++ b/platform-bible-utils/types/ProjectSettingsContribution.html @@ -1,2 +1,2 @@ ProjectSettingsContribution | platform-bible-utils

        Type alias ProjectSettingsContribution

        ProjectSettingsContribution: ProjectSettingsGroup | ProjectSettingsGroup[]

        The data an extension provides to inform Platform.Bible of the project settings it provides

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index f532b28f27..f6158fd9a5 100644 --- a/platform-bible-utils/types/ReferencedItem.html +++ b/platform-bible-utils/types/ReferencedItem.html @@ -1,2 +1,2 @@ ReferencedItem | platform-bible-utils

        Type alias ReferencedItem

        ReferencedItem: `${string}.${string}`

        Name of some UI element (i.e., tab, column, group, menu item) or some PAPI object (i.e., command)

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index dd9df5ed77..8671d025b4 100644 --- a/platform-bible-utils/types/ReplaceType.html +++ b/platform-bible-utils/types/ReplaceType.html @@ -1,2 +1,2 @@ ReplaceType | platform-bible-utils

        Type alias ReplaceType<T, A, B>

        ReplaceType<T, A, B>: T extends A
            ? B
            : T extends object
                ? {
                    [K in keyof T]: ReplaceType<T[K], A, B>
                }
                : T

        Within type T, recursively change properties that were of type A to be of type B

        -

        Type Parameters

        • T

        • A

        • B

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index f42612df84..fcada09a86 100644 --- a/platform-bible-utils/types/Setting.html +++ b/platform-bible-utils/types/Setting.html @@ -1,2 +1,2 @@ Setting | platform-bible-utils

        Type alias Setting

        A description of an extension's setting entry

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index 3d00c836c6..5e3e250b1b 100644 --- a/platform-bible-utils/types/SettingBase.html +++ b/platform-bible-utils/types/SettingBase.html @@ -1,4 +1,4 @@ SettingBase | platform-bible-utils

        Type alias SettingBase

        SettingBase: StateBase & {
            description?: LocalizeKey;
            label: LocalizeKey;
            [k: string]: unknown;
        }

        Base information needed to describe a setting entry

        Type declaration

        • [k: string]: unknown
        • Optional description?: LocalizeKey

          LocalizeKey that displays in the settings dialog to describe the setting

        • label: LocalizeKey

          LocalizeKey that displays in the settings dialog as the setting name

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index d14887b359..d350b9b395 100644 --- a/platform-bible-utils/types/SettingsContribution.html +++ b/platform-bible-utils/types/SettingsContribution.html @@ -1,2 +1,2 @@ SettingsContribution | platform-bible-utils

        Type alias SettingsContribution

        SettingsContribution: SettingsGroup | SettingsGroup[]

        The data an extension provides to inform Platform.Bible of the settings it provides

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index 97a0e5aa78..11254215ad 100644 --- a/platform-bible-utils/types/SingleColumnMenu.html +++ b/platform-bible-utils/types/SingleColumnMenu.html @@ -1,4 +1,4 @@ SingleColumnMenu | platform-bible-utils

        Type alias SingleColumnMenu

        SingleColumnMenu: {
            groups: GroupsInSingleColumnMenu;
            items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
        }

        Menu that contains a column without a header

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index 8be10e7ec2..e9c9f5eaab 100644 --- a/platform-bible-utils/types/Unsubscriber.html +++ b/platform-bible-utils/types/Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | platform-bible-utils

        Type alias Unsubscriber

        Unsubscriber: (() => boolean)

        Function to run to dispose of something. Returns true if successfully unsubscribed

        -

        Type declaration

          • (): boolean
          • Returns boolean

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index ab233bd87f..19839f6857 100644 --- a/platform-bible-utils/types/UnsubscriberAsync.html +++ b/platform-bible-utils/types/UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | platform-bible-utils

        Type alias UnsubscriberAsync

        UnsubscriberAsync: (() => Promise<boolean>)

        Function to run to dispose of something that runs asynchronously. The promise resolves to true if successfully unsubscribed

        -

        Type declaration

          • (): Promise<boolean>
          • Returns Promise<boolean>

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index 8780b46210..1dfe8120d5 100644 --- a/platform-bible-utils/types/UserState.html +++ b/platform-bible-utils/types/UserState.html @@ -1,2 +1,2 @@ UserState | platform-bible-utils

        Type alias UserState

        A description of an extension's user state entry

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index d7679a8348..359eb827b3 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index f8cbd2a2d7..b66046257d 100644 --- a/platform-bible-utils/types/WebViewMenus.html +++ b/platform-bible-utils/types/WebViewMenus.html @@ -1,3 +1,3 @@ WebViewMenus | platform-bible-utils

        Type alias WebViewMenus

        WebViewMenus: {
            [property: ReferencedItem]: WebViewMenu;
        }

        Menus for all web views

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html index f59defe4df..9252c528f1 100644 --- a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html @@ -1 +1 @@ -FIRST_SCR_BOOK_NUM | platform-bible-utils

        Variable FIRST_SCR_BOOK_NUMConst

        FIRST_SCR_BOOK_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file +FIRST_SCR_BOOK_NUM | platform-bible-utils

        Variable FIRST_SCR_BOOK_NUMConst

        FIRST_SCR_BOOK_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html index 23ae68de43..a0abb9e512 100644 --- a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html @@ -1 +1 @@ -FIRST_SCR_CHAPTER_NUM | platform-bible-utils

        Variable FIRST_SCR_CHAPTER_NUMConst

        FIRST_SCR_CHAPTER_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

        Variable FIRST_SCR_CHAPTER_NUMConst

        FIRST_SCR_CHAPTER_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html index 955c0c5511..da3ebae6c5 100644 --- a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html @@ -1 +1 @@ -FIRST_SCR_VERSE_NUM | platform-bible-utils

        Variable FIRST_SCR_VERSE_NUMConst

        FIRST_SCR_VERSE_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file +FIRST_SCR_VERSE_NUM | platform-bible-utils

        Variable FIRST_SCR_VERSE_NUMConst

        FIRST_SCR_VERSE_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html index 89b41046c5..dc6ab45dc4 100644 --- a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html @@ -1 +1 @@ -LAST_SCR_BOOK_NUM | platform-bible-utils

        Variable LAST_SCR_BOOK_NUMConst

        LAST_SCR_BOOK_NUM: number = ...

        Generated using TypeDoc

        \ No newline at end of file +LAST_SCR_BOOK_NUM | platform-bible-utils

        Variable LAST_SCR_BOOK_NUMConst

        LAST_SCR_BOOK_NUM: number = ...

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index 54d15fa1cf..cbdb5ab133 100644 --- a/platform-bible-utils/variables/menuDocumentSchema.html +++ b/platform-bible-utils/variables/menuDocumentSchema.html @@ -1,2 +1,2 @@ menuDocumentSchema | platform-bible-utils

        Variable menuDocumentSchemaConst

        menuDocumentSchema: {
            $defs: {
                columnsWithHeaders: {
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            additionalProperties: boolean;
                            description: string;
                            properties: {
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                                localizeNotes: {
                                    description: string;
                                    type: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                    };
                    properties: {
                        isExtensible: {
                            description: string;
                            type: string;
                        };
                    };
                    type: string;
                };
                groupsAndItems: {
                    description: string;
                    properties: {
                        groups: {
                            $ref: string;
                            description: string;
                        };
                        items: {
                            description: string;
                            items: {
                                $ref: string;
                            };
                            type: string;
                            uniqueItems: boolean;
                        };
                    };
                    required: string[];
                    type: string;
                };
                localizeKey: {
                    description: string;
                    pattern: string;
                    type: string;
                };
                menuGroups: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            description: string;
                            oneOf: ({
                                additionalProperties: boolean;
                                properties: {
                                    column: {
                                        $ref: string;
                                        description: string;
                                    };
                                    isExtensible: {
                                        description: string;
                                        type: string;
                                    };
                                    menuItem?: undefined;
                                    order: {
                                        description: string;
                                        type: string;
                                    };
                                };
                                required: string[];
                            } | {
                                additionalProperties: boolean;
                                properties: {
                                    column?: undefined;
                                    isExtensible: {
                                        description: string;
                                        type: string;
                                    };
                                    menuItem: {
                                        $ref: string;
                                        description: string;
                                    };
                                    order: {
                                        description: string;
                                        type: string;
                                    };
                                };
                                required: string[];
                            })[];
                            type: string;
                        };
                    };
                    type: string;
                };
                menuItem: {
                    description: string;
                    oneOf: ({
                        properties: {
                            command?: undefined;
                            iconPathAfter?: undefined;
                            iconPathBefore?: undefined;
                            id: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                    } | {
                        properties: {
                            command: {
                                $ref: string;
                                description: string;
                            };
                            iconPathAfter: {
                                description: string;
                                type: string;
                            };
                            iconPathBefore: {
                                description: string;
                                type: string;
                            };
                            id?: undefined;
                        };
                        required: string[];
                    })[];
                    properties: {
                        group: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        localizeNotes: {
                            description: string;
                            type: string;
                        };
                        order: {
                            description: string;
                            type: string;
                        };
                        searchTerms: {
                            $ref: string;
                            description: string;
                        };
                        tooltip: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                    unevaluatedProperties: boolean;
                };
                menusForOneWebView: {
                    additionalProperties: boolean;
                    description: string;
                    properties: {
                        contextMenu: {
                            $ref: string;
                            description: string;
                        };
                        includeDefaults: {
                            description: string;
                            type: string;
                        };
                        topMenu: {
                            $ref: string;
                            description: string;
                        };
                    };
                    type: string;
                };
                multiColumnMenu: {
                    allOf: ({
                        $ref: string;
                        properties?: undefined;
                        required?: undefined;
                    } | {
                        $ref?: undefined;
                        properties: {
                            columns: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                    })[];
                    description: string;
                    type: string;
                    unevaluatedProperties: boolean;
                };
                referencedItem: {
                    description: string;
                    pattern: string;
                    type: string;
                };
                singleColumnMenu: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                    type: string;
                    unevaluatedProperties: boolean;
                };
            };
            additionalProperties: boolean;
            properties: {
                defaultWebViewContextMenu: {
                    $ref: string;
                    description: string;
                };
                defaultWebViewTopMenu: {
                    $ref: string;
                    description: string;
                };
                mainMenu: {
                    $ref: string;
                    description: string;
                };
                webViewMenus: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
            };
            required: string[];
            title: string;
            type: string;
        } = ...

        JSON schema object that aligns with the PlatformMenus type

        -

        Type declaration

        • $defs: {
              columnsWithHeaders: {
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          additionalProperties: boolean;
                          description: string;
                          properties: {
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              localizeNotes: {
                                  description: string;
                                  type: string;
                              };
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                  };
                  properties: {
                      isExtensible: {
                          description: string;
                          type: string;
                      };
                  };
                  type: string;
              };
              groupsAndItems: {
                  description: string;
                  properties: {
                      groups: {
                          $ref: string;
                          description: string;
                      };
                      items: {
                          description: string;
                          items: {
                              $ref: string;
                          };
                          type: string;
                          uniqueItems: boolean;
                      };
                  };
                  required: string[];
                  type: string;
              };
              localizeKey: {
                  description: string;
                  pattern: string;
                  type: string;
              };
              menuGroups: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          description: string;
                          oneOf: ({
                              additionalProperties: boolean;
                              properties: {
                                  column: {
                                      $ref: string;
                                      description: string;
                                  };
                                  isExtensible: {
                                      description: string;
                                      type: string;
                                  };
                                  menuItem?: undefined;
                                  order: {
                                      description: string;
                                      type: string;
                                  };
                              };
                              required: string[];
                          } | {
                              additionalProperties: boolean;
                              properties: {
                                  column?: undefined;
                                  isExtensible: {
                                      description: string;
                                      type: string;
                                  };
                                  menuItem: {
                                      $ref: string;
                                      description: string;
                                  };
                                  order: {
                                      description: string;
                                      type: string;
                                  };
                              };
                              required: string[];
                          })[];
                          type: string;
                      };
                  };
                  type: string;
              };
              menuItem: {
                  description: string;
                  oneOf: ({
                      properties: {
                          command?: undefined;
                          iconPathAfter?: undefined;
                          iconPathBefore?: undefined;
                          id: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                  } | {
                      properties: {
                          command: {
                              $ref: string;
                              description: string;
                          };
                          iconPathAfter: {
                              description: string;
                              type: string;
                          };
                          iconPathBefore: {
                              description: string;
                              type: string;
                          };
                          id?: undefined;
                      };
                      required: string[];
                  })[];
                  properties: {
                      group: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      localizeNotes: {
                          description: string;
                          type: string;
                      };
                      order: {
                          description: string;
                          type: string;
                      };
                      searchTerms: {
                          $ref: string;
                          description: string;
                      };
                      tooltip: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
                  unevaluatedProperties: boolean;
              };
              menusForOneWebView: {
                  additionalProperties: boolean;
                  description: string;
                  properties: {
                      contextMenu: {
                          $ref: string;
                          description: string;
                      };
                      includeDefaults: {
                          description: string;
                          type: string;
                      };
                      topMenu: {
                          $ref: string;
                          description: string;
                      };
                  };
                  type: string;
              };
              multiColumnMenu: {
                  allOf: ({
                      $ref: string;
                      properties?: undefined;
                      required?: undefined;
                  } | {
                      $ref?: undefined;
                      properties: {
                          columns: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                  })[];
                  description: string;
                  type: string;
                  unevaluatedProperties: boolean;
              };
              referencedItem: {
                  description: string;
                  pattern: string;
                  type: string;
              };
              singleColumnMenu: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
                  type: string;
                  unevaluatedProperties: boolean;
              };
          }
          • columnsWithHeaders: {
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        additionalProperties: boolean;
                        description: string;
                        properties: {
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            localizeNotes: {
                                description: string;
                                type: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                        type: string;
                    };
                };
                properties: {
                    isExtensible: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            }
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      additionalProperties: boolean;
                      description: string;
                      properties: {
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          localizeNotes: {
                              description: string;
                              type: string;
                          };
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                      type: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    additionalProperties: boolean;
                    description: string;
                    properties: {
                        isExtensible: {
                            description: string;
                            type: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        localizeNotes: {
                            description: string;
                            type: string;
                        };
                        order: {
                            description: string;
                            type: string;
                        };
                    };
                    required: string[];
                    type: string;
                }
                • additionalProperties: boolean
                • description: string
                • properties: {
                      isExtensible: {
                          description: string;
                          type: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      localizeNotes: {
                          description: string;
                          type: string;
                      };
                      order: {
                          description: string;
                          type: string;
                      };
                  }
                  • isExtensible: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • label: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • localizeNotes: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • order: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                • required: string[]
                • type: string
            • properties: {
                  isExtensible: {
                      description: string;
                      type: string;
                  };
              }
              • isExtensible: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
            • type: string
          • groupsAndItems: {
                description: string;
                properties: {
                    groups: {
                        $ref: string;
                        description: string;
                    };
                    items: {
                        description: string;
                        items: {
                            $ref: string;
                        };
                        type: string;
                        uniqueItems: boolean;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  groups: {
                      $ref: string;
                      description: string;
                  };
                  items: {
                      description: string;
                      items: {
                          $ref: string;
                      };
                      type: string;
                      uniqueItems: boolean;
                  };
              }
              • groups: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • items: {
                    description: string;
                    items: {
                        $ref: string;
                    };
                    type: string;
                    uniqueItems: boolean;
                }
                • description: string
                • items: {
                      $ref: string;
                  }
                  • $ref: string
                • type: string
                • uniqueItems: boolean
            • required: string[]
            • type: string
          • localizeKey: {
                description: string;
                pattern: string;
                type: string;
            }
            • description: string
            • pattern: string
            • type: string
          • menuGroups: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        description: string;
                        oneOf: ({
                            additionalProperties: boolean;
                            properties: {
                                column: {
                                    $ref: string;
                                    description: string;
                                };
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem?: undefined;
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        } | {
                            additionalProperties: boolean;
                            properties: {
                                column?: undefined;
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem: {
                                    $ref: string;
                                    description: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        })[];
                        type: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      description: string;
                      oneOf: ({
                          additionalProperties: boolean;
                          properties: {
                              column: {
                                  $ref: string;
                                  description: string;
                              };
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              menuItem?: undefined;
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                      } | {
                          additionalProperties: boolean;
                          properties: {
                              column?: undefined;
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              menuItem: {
                                  $ref: string;
                                  description: string;
                              };
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                      })[];
                      type: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    description: string;
                    oneOf: ({
                        additionalProperties: boolean;
                        properties: {
                            column: {
                                $ref: string;
                                description: string;
                            };
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            menuItem?: undefined;
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                    } | {
                        additionalProperties: boolean;
                        properties: {
                            column?: undefined;
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            menuItem: {
                                $ref: string;
                                description: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                    })[];
                    type: string;
                }
                • description: string
                • oneOf: ({
                      additionalProperties: boolean;
                      properties: {
                          column: {
                              $ref: string;
                              description: string;
                          };
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          menuItem?: undefined;
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                  } | {
                      additionalProperties: boolean;
                      properties: {
                          column?: undefined;
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          menuItem: {
                              $ref: string;
                              description: string;
                          };
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                  })[]
                • type: string
            • type: string
          • menuItem: {
                description: string;
                oneOf: ({
                    properties: {
                        command?: undefined;
                        iconPathAfter?: undefined;
                        iconPathBefore?: undefined;
                        id: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                } | {
                    properties: {
                        command: {
                            $ref: string;
                            description: string;
                        };
                        iconPathAfter: {
                            description: string;
                            type: string;
                        };
                        iconPathBefore: {
                            description: string;
                            type: string;
                        };
                        id?: undefined;
                    };
                    required: string[];
                })[];
                properties: {
                    group: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    localizeNotes: {
                        description: string;
                        type: string;
                    };
                    order: {
                        description: string;
                        type: string;
                    };
                    searchTerms: {
                        $ref: string;
                        description: string;
                    };
                    tooltip: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
                unevaluatedProperties: boolean;
            }
            • description: string
            • oneOf: ({
                  properties: {
                      command?: undefined;
                      iconPathAfter?: undefined;
                      iconPathBefore?: undefined;
                      id: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
              } | {
                  properties: {
                      command: {
                          $ref: string;
                          description: string;
                      };
                      iconPathAfter: {
                          description: string;
                          type: string;
                      };
                      iconPathBefore: {
                          description: string;
                          type: string;
                      };
                      id?: undefined;
                  };
                  required: string[];
              })[]
            • properties: {
                  group: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  localizeNotes: {
                      description: string;
                      type: string;
                  };
                  order: {
                      description: string;
                      type: string;
                  };
                  searchTerms: {
                      $ref: string;
                      description: string;
                  };
                  tooltip: {
                      $ref: string;
                      description: string;
                  };
              }
              • group: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • localizeNotes: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • order: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • searchTerms: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • tooltip: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • required: string[]
            • type: string
            • unevaluatedProperties: boolean
          • menusForOneWebView: {
                additionalProperties: boolean;
                description: string;
                properties: {
                    contextMenu: {
                        $ref: string;
                        description: string;
                    };
                    includeDefaults: {
                        description: string;
                        type: string;
                    };
                    topMenu: {
                        $ref: string;
                        description: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • properties: {
                  contextMenu: {
                      $ref: string;
                      description: string;
                  };
                  includeDefaults: {
                      description: string;
                      type: string;
                  };
                  topMenu: {
                      $ref: string;
                      description: string;
                  };
              }
              • contextMenu: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • includeDefaults: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • topMenu: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • type: string
          • multiColumnMenu: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        columns: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                })[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            }
            • allOf: ({
                  $ref: string;
                  properties?: undefined;
                  required?: undefined;
              } | {
                  $ref?: undefined;
                  properties: {
                      columns: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
              })[]
            • description: string
            • type: string
            • unevaluatedProperties: boolean
          • referencedItem: {
                description: string;
                pattern: string;
                type: string;
            }
            • description: string
            • pattern: string
            • type: string
          • singleColumnMenu: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
            • type: string
            • unevaluatedProperties: boolean
        • additionalProperties: boolean
        • properties: {
              defaultWebViewContextMenu: {
                  $ref: string;
                  description: string;
              };
              defaultWebViewTopMenu: {
                  $ref: string;
                  description: string;
              };
              mainMenu: {
                  $ref: string;
                  description: string;
              };
              webViewMenus: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
          }
          • defaultWebViewContextMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • defaultWebViewTopMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • mainMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • webViewMenus: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
        • required: string[]
        • title: string
        • type: string

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index 71f743ef9c..6c34549634 100644 --- a/platform-bible-utils/variables/projectSettingsDocumentSchema.html +++ b/platform-bible-utils/variables/projectSettingsDocumentSchema.html @@ -1,2 +1,2 @@ projectSettingsDocumentSchema | platform-bible-utils

        Variable projectSettingsDocumentSchemaConst

        projectSettingsDocumentSchema: {
            $defs: {
                extensionControlledProjectSetting: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                extensionControlledSetting: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                extensionControlledState: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                id: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                localizeKey: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                modifierExtensionControlled: {
                    description: string;
                    not: {
                        anyOf: {
                            required: string[];
                            type: string;
                        }[];
                    };
                };
                modifierProject: {
                    description: string;
                    properties: {
                        excludeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        includeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                    };
                    type: string;
                };
                projectSetting: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                projectSettingBase: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                projectSettingProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                projectSettingsContribution: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                };
                projectSettingsGroup: {
                    description: string;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        properties: {
                            $ref: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                projectStateContribution: {
                    $ref: string;
                    description: string;
                };
                setting: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                settingBase: {
                    allOf: ({
                        $ref: string;
                        properties?: undefined;
                        required?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    })[];
                    description: string;
                };
                settingProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                settingsContribution: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                };
                settingsGroup: {
                    description: string;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        properties: {
                            $ref: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                stateBase: {
                    description: string;
                    properties: {
                        default: {
                            description: string;
                            type: string;
                        };
                        derivesFrom: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                userState: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                userStateContribution: {
                    $ref: string;
                    description: string;
                };
                userStateProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
            };
            $schema: string;
            anyOf: ({
                $ref: string;
                items?: undefined;
                type?: undefined;
            } | {
                $ref?: undefined;
                items: {
                    $ref: string;
                };
                type: string;
            })[];
            description: string;
            title: string;
        } = ...

        JSON schema object that aligns with the ProjectSettingsContribution type

        -

        Type declaration

        • $defs: {
              extensionControlledProjectSetting: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              extensionControlledSetting: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              extensionControlledState: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              id: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              localizeKey: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              modifierExtensionControlled: {
                  description: string;
                  not: {
                      anyOf: {
                          required: string[];
                          type: string;
                      }[];
                  };
              };
              modifierProject: {
                  description: string;
                  properties: {
                      excludeProjectTypes: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      includeProjectTypes: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                  };
                  type: string;
              };
              projectSetting: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              projectSettingBase: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              projectSettingProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              projectSettingsContribution: {
                  anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[];
                  description: string;
              };
              projectSettingsGroup: {
                  description: string;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      properties: {
                          $ref: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              projectStateContribution: {
                  $ref: string;
                  description: string;
              };
              setting: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              settingBase: {
                  allOf: ({
                      $ref: string;
                      properties?: undefined;
                      required?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                      type: string;
                  })[];
                  description: string;
              };
              settingProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w-]+\.[\w-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              settingsContribution: {
                  anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[];
                  description: string;
              };
              settingsGroup: {
                  description: string;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      properties: {
                          $ref: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              stateBase: {
                  description: string;
                  properties: {
                      default: {
                          description: string;
                          type: string;
                      };
                      derivesFrom: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              userState: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              userStateContribution: {
                  $ref: string;
                  description: string;
              };
              userStateProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
          }
          • extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            }
            • description: string
            • not: {
                  anyOf: {
                      required: string[];
                      type: string;
                  }[];
              }
              • anyOf: {
                    required: string[];
                    type: string;
                }[]
          • modifierProject: {
                description: string;
                properties: {
                    excludeProjectTypes: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectTypes: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            }
            • description: string
            • properties: {
                  excludeProjectTypes: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  includeProjectTypes: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
              }
              • excludeProjectTypes: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
              • includeProjectTypes: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
            • type: string
          • projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            }
            • anyOf: ({
                  $ref: string;
                  items?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  items: {
                      $ref: string;
                  };
                  type: string;
              })[]
            • description: string
          • projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  description: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  properties: {
                      $ref: string;
                  };
              }
              • description: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • properties: {
                    $ref: string;
                }
                • $ref: string
            • required: string[]
            • type: string
          • projectStateContribution: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            }
            • allOf: ({
                  $ref: string;
                  properties?: undefined;
                  required?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
              })[]
            • description: string
          • settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w-]+\.[\w-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w-]+\.[\w-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            }
            • anyOf: ({
                  $ref: string;
                  items?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  items: {
                      $ref: string;
                  };
                  type: string;
              })[]
            • description: string
          • settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  description: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  properties: {
                      $ref: string;
                  };
              }
              • description: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • properties: {
                    $ref: string;
                }
                • $ref: string
            • required: string[]
            • type: string
          • stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  default: {
                      description: string;
                      type: string;
                  };
                  derivesFrom: {
                      $ref: string;
                      description: string;
                  };
              }
              • default: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • derivesFrom: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • required: string[]
            • type: string
          • userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • userStateContribution: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
        • $schema: string
        • anyOf: ({
              $ref: string;
              items?: undefined;
              type?: undefined;
          } | {
              $ref?: undefined;
              items: {
                  $ref: string;
              };
              type: string;
          })[]
        • description: string
        • title: string

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index 614b790d87..530a267ce8 100644 --- a/platform-bible-utils/variables/settingsDocumentSchema.html +++ b/platform-bible-utils/variables/settingsDocumentSchema.html @@ -1,2 +1,2 @@ settingsDocumentSchema | platform-bible-utils

        Variable settingsDocumentSchemaConst

        settingsDocumentSchema: {
            $defs: {
                extensionControlledProjectSetting: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                extensionControlledSetting: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                extensionControlledState: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                id: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                localizeKey: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                modifierExtensionControlled: {
                    description: string;
                    not: {
                        anyOf: {
                            required: string[];
                            type: string;
                        }[];
                    };
                };
                modifierProject: {
                    description: string;
                    properties: {
                        excludeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        includeProjectTypes: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                    };
                    type: string;
                };
                projectSetting: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                projectSettingBase: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                projectSettingProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                projectSettingsContribution: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                };
                projectSettingsGroup: {
                    description: string;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        properties: {
                            $ref: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                projectStateContribution: {
                    $ref: string;
                    description: string;
                };
                setting: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                settingBase: {
                    allOf: ({
                        $ref: string;
                        properties?: undefined;
                        required?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    })[];
                    description: string;
                };
                settingProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                settingsContribution: {
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                };
                settingsGroup: {
                    description: string;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        properties: {
                            $ref: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                stateBase: {
                    description: string;
                    properties: {
                        default: {
                            description: string;
                            type: string;
                        };
                        derivesFrom: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                };
                userState: {
                    anyOf: {
                        $ref: string;
                    }[];
                    description: string;
                };
                userStateContribution: {
                    $ref: string;
                    description: string;
                };
                userStateProperties: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
            };
            $schema: string;
            anyOf: ({
                $ref: string;
                items?: undefined;
                type?: undefined;
            } | {
                $ref?: undefined;
                items: {
                    $ref: string;
                };
                type: string;
            })[];
            description: string;
            title: string;
        } = ...

        JSON schema object that aligns with the SettingsContribution type

        -

        Type declaration

        • $defs: {
              extensionControlledProjectSetting: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              extensionControlledSetting: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              extensionControlledState: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              id: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              localizeKey: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              modifierExtensionControlled: {
                  description: string;
                  not: {
                      anyOf: {
                          required: string[];
                          type: string;
                      }[];
                  };
              };
              modifierProject: {
                  description: string;
                  properties: {
                      excludeProjectTypes: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      includeProjectTypes: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                  };
                  type: string;
              };
              projectSetting: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              projectSettingBase: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              projectSettingProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              projectSettingsContribution: {
                  anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[];
                  description: string;
              };
              projectSettingsGroup: {
                  description: string;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      properties: {
                          $ref: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              projectStateContribution: {
                  $ref: string;
                  description: string;
              };
              setting: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              settingBase: {
                  allOf: ({
                      $ref: string;
                      properties?: undefined;
                      required?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                      type: string;
                  })[];
                  description: string;
              };
              settingProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w-]+\.[\w-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              settingsContribution: {
                  anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[];
                  description: string;
              };
              settingsGroup: {
                  description: string;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      properties: {
                          $ref: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              stateBase: {
                  description: string;
                  properties: {
                      default: {
                          description: string;
                          type: string;
                      };
                      derivesFrom: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
              };
              userState: {
                  anyOf: {
                      $ref: string;
                  }[];
                  description: string;
              };
              userStateContribution: {
                  $ref: string;
                  description: string;
              };
              userStateProperties: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
          }
          • extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            }
            • description: string
            • not: {
                  anyOf: {
                      required: string[];
                      type: string;
                  }[];
              }
              • anyOf: {
                    required: string[];
                    type: string;
                }[]
          • modifierProject: {
                description: string;
                properties: {
                    excludeProjectTypes: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectTypes: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            }
            • description: string
            • properties: {
                  excludeProjectTypes: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  includeProjectTypes: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
              }
              • excludeProjectTypes: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
              • includeProjectTypes: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
            • type: string
          • projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
          • projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            }
            • anyOf: ({
                  $ref: string;
                  items?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  items: {
                      $ref: string;
                  };
                  type: string;
              })[]
            • description: string
          • projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  description: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  properties: {
                      $ref: string;
                  };
              }
              • description: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • properties: {
                    $ref: string;
                }
                • $ref: string
            • required: string[]
            • type: string
          • projectStateContribution: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            }
            • allOf: ({
                  $ref: string;
                  properties?: undefined;
                  required?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  properties: {
                      description: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
              })[]
            • description: string
          • settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w-]+\.[\w-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w-]+\.[\w-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            }
            • anyOf: ({
                  $ref: string;
                  items?: undefined;
                  type?: undefined;
              } | {
                  $ref?: undefined;
                  items: {
                      $ref: string;
                  };
                  type: string;
              })[]
            • description: string
          • settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  description: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  properties: {
                      $ref: string;
                  };
              }
              • description: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • properties: {
                    $ref: string;
                }
                • $ref: string
            • required: string[]
            • type: string
          • stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  default: {
                      description: string;
                      type: string;
                  };
                  derivesFrom: {
                      $ref: string;
                      description: string;
                  };
              }
              • default: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • derivesFrom: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • required: string[]
            • type: string
          • userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            }
            • anyOf: {
                  $ref: string;
              }[]
            • description: string
          • userStateContribution: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
        • $schema: string
        • anyOf: ({
              $ref: string;
              items?: undefined;
              type?: undefined;
          } | {
              $ref?: undefined;
              items: {
                  $ref: string;
              };
              type: string;
          })[]
        • description: string
        • title: string

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file