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 4c590942d4..1f01b8c8be 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

Class default

Handles the connection from the client to the server

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

clientGuid connect connectPromise? @@ -26,7 +26,7 @@ unsubscribeHandleResponseMessage? webSocket?

Constructors

constructor

Properties

Private clientGuid

clientGuid: any

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

-

connect

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

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

connect

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.
    • @@ -34,59 +34,59 @@

MUST ALSO RUN notifyClientConnected() WHEN PROMISE RESOLVES

Type declaration

Returns

Promise that resolves with connector info when finished connecting

-

Private Optional connectPromise

connectPromise?: any

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

Private Optional connectPromise

connectPromise?: any

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

-

connectionStatus

connectionStatus: ConnectionStatus

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

connectionStatus

connectionStatus: ConnectionStatus

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

-

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

-

Type declaration

  • clientId: number

disconnect

disconnect: (() => void)

Disconnects from the connection:

+

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number

disconnect

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

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

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>

Private handleEventMessage

handleEventMessage: any

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

Type declaration

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

    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

Private handleEventMessage

handleEventMessage: any

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

Param: eventMessage

Event message to handle

-

Private handleRequestMessage

handleRequestMessage: any

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

Private handleRequestMessage

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

-

Private handleResponseMessage

handleResponseMessage: any

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

Private handleResponseMessage

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

-

Private Optional localEventHandler

localEventHandler?: any

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

Private Optional localEventHandler

localEventHandler?: any

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

-

Private Optional localRequestHandler

localRequestHandler?: any

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

Private Optional localRequestHandler

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

-

Private messageEmitters

messageEmitters: any

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

Private messageEmitters

messageEmitters: any

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

-

notifyClientConnected

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

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

+

notifyClientConnected

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>

Private onMessage

onMessage: any

Receives and appropriately publishes server webSocket messages

+

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Private onMessage

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

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

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

+

request

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

-

Private Optional requestRouter

requestRouter?: any

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

Private Optional requestRouter

requestRouter?: any

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

-

Private requests

requests: any

All requests that are waiting for a response

-

Private sendMessage

sendMessage: any

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

+

Private requests

requests: any

All requests that are waiting for a response

+

Private sendMessage

sendMessage: any

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

Param: message

Message to send

-

Private subscribe

subscribe: any

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

+

Private subscribe

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

-

Private Optional unsubscribeHandleEventMessage

unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-

Private Optional unsubscribeHandleInitClientMessage

unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

-

Private Optional unsubscribeHandleRequestMessage

unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

-

Private Optional unsubscribeHandleResponseMessage

unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

-

Private Optional webSocket

webSocket?: any

The webSocket connected to the server

-

Settings

Member Visibility

Theme

On This Page

constructorclientGuidconnectconnectPromiseconnectionStatusconnectorInfodisconnectemitEventOnNetworkhandleEventMessagehandleRequestMessagehandleResponseMessagelocalEventHandlerlocalRequestHandlermessageEmittersnotifyClientConnectedonMessagerequestrequestRouterrequestssendMessagesubscribeunsubscribeHandleEventMessageunsubscribeHandleInitClientMessageunsubscribeHandleRequestMessageunsubscribeHandleResponseMessagewebSocket
\ No newline at end of file +

Private Optional unsubscribeHandleEventMessage

unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+

Private Optional unsubscribeHandleInitClientMessage

unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

+

Private Optional unsubscribeHandleRequestMessage

unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

+

Private Optional unsubscribeHandleResponseMessage

unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

+

Private Optional webSocket

webSocket?: any

The webSocket connected to the server

+

Settings

Member Visibility

Theme

On This Page

constructorclientGuidconnectconnectPromiseconnectionStatusconnectorInfodisconnectemitEventOnNetworkhandleEventMessagehandleRequestMessagehandleResponseMessagelocalEventHandlerlocalRequestHandlermessageEmittersnotifyClientConnectedonMessagerequestrequestRouterrequestssendMessagesubscribeunsubscribeHandleEventMessageunsubscribeHandleInitClientMessageunsubscribeHandleRequestMessageunsubscribeHandleResponseMessagewebSocket
\ 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 968cfdf144..f1e90125b5 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

Class default

Handles the endpoint and connections from the server to the clients

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

clientSockets connect connectPromise? @@ -35,7 +35,7 @@ unsubscribeHandleResponseMessage? webSocketServer?

Constructors

constructor

Properties

Private clientSockets

clientSockets: any

The webSocket clients that are connected and information about them

-

connect

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

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

connect

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.
    • @@ -43,77 +43,77 @@

MUST ALSO RUN notifyClientConnected() WHEN PROMISE RESOLVES

Type declaration

Returns

Promise that resolves with connector info when finished connecting

-

Private Optional connectPromise

connectPromise?: any

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

Private Optional connectPromise

connectPromise?: any

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

-

connectionStatus

connectionStatus: ConnectionStatus

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

connectionStatus

connectionStatus: ConnectionStatus

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

-

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

-

Type declaration

  • clientId: number

disconnect

disconnect: (() => void)

Disconnects from the connection:

+

connectorInfo

connectorInfo: Readonly<{
    clientId: number;
}>

Information about the connector. Populated by the server while connecting

+

Type declaration

  • clientId: number

disconnect

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

Private disconnectClient

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

-

emitEventOnNetwork

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

Private disconnectClient

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

+

emitEventOnNetwork

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>

Private getClientIdFromSocket

getClientIdFromSocket: any

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

-

Private getClientSocket

getClientSocket: any

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

-

Private getClientSocketFromGuid

getClientSocketFromGuid: any

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

Type declaration

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

    • Type Parameters

      • T

      Parameters

      Returns Promise<void>

Private getClientIdFromSocket

getClientIdFromSocket: any

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

+

Private getClientSocket

getClientSocket: any

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

+

Private getClientSocketFromGuid

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.

-

Private handleClientConnectMessage

handleClientConnectMessage: any

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

Private handleClientConnectMessage

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

-

Private handleEventMessage

handleEventMessage: any

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

Private handleEventMessage

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

-

Private handleRequestMessage

handleRequestMessage: any

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

Private handleRequestMessage

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

-

Private handleResponseMessage

handleResponseMessage: any

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

Private handleResponseMessage

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

-

Private Optional localEventHandler

localEventHandler?: any

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

Private Optional localEventHandler

localEventHandler?: any

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

-

Private Optional localRequestHandler

localRequestHandler?: any

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

Private Optional localRequestHandler

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

-

Private messageEmitters

messageEmitters: any

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

Private messageEmitters

messageEmitters: any

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

-

Private Optional networkConnectorEventHandlers

networkConnectorEventHandlers?: any

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

-

Private nextClientId

nextClientId: any

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

-

notifyClientConnected

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

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

+

Private Optional networkConnectorEventHandlers

networkConnectorEventHandlers?: any

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

+

Private nextClientId

nextClientId: any

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

+

notifyClientConnected

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>

Private onClientConnect

onClientConnect: any

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Private onClientConnect

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

-

Private onClientDisconnect

onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

-

Private onMessage

onMessage: any

Receives and appropriately publishes webSocket messages

+

Private onClientDisconnect

onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

+

Private onMessage

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

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

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

+

request

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

-

Private Optional requestRouter

requestRouter?: any

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

Private Optional requestRouter

requestRouter?: any

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

-

Private requests

requests: any

All requests that are waiting for a response

-

Private sendMessage

sendMessage: any

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

+

Private requests

requests: any

All requests that are waiting for a response

+

Private sendMessage

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

-

Private subscribe

subscribe: any

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

+

Private subscribe

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

-

Private Optional unsubscribeHandleClientConnectMessage

unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

-

Private Optional unsubscribeHandleEventMessage

unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-

Private Optional unsubscribeHandleRequestMessage

unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

-

Private Optional unsubscribeHandleResponseMessage

unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

-

Private Optional webSocketServer

webSocketServer?: any

The webSocket connected to the server

-

Settings

Member Visibility

Theme

On This Page

constructorclientSocketsconnectconnectPromiseconnectionStatusconnectorInfodisconnectdisconnectClientemitEventOnNetworkgetClientIdFromSocketgetClientSocketgetClientSocketFromGuidhandleClientConnectMessagehandleEventMessagehandleRequestMessagehandleResponseMessagelocalEventHandlerlocalRequestHandlermessageEmittersnetworkConnectorEventHandlersnextClientIdnotifyClientConnectedonClientConnectonClientDisconnectonMessagerequestrequestRouterrequestssendMessagesubscribeunsubscribeHandleClientConnectMessageunsubscribeHandleEventMessageunsubscribeHandleRequestMessageunsubscribeHandleResponseMessagewebSocketServer
\ No newline at end of file +

Private Optional unsubscribeHandleClientConnectMessage

unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

+

Private Optional unsubscribeHandleEventMessage

unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+

Private Optional unsubscribeHandleRequestMessage

unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

+

Private Optional unsubscribeHandleResponseMessage

unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

+

Private Optional webSocketServer

webSocketServer?: any

The webSocket connected to the server

+

Settings

Member Visibility

Theme

On This Page

constructorclientSocketsconnectconnectPromiseconnectionStatusconnectorInfodisconnectdisconnectClientemitEventOnNetworkgetClientIdFromSocketgetClientSocketgetClientSocketFromGuidhandleClientConnectMessagehandleEventMessagehandleRequestMessagehandleResponseMessagelocalEventHandlerlocalRequestHandlermessageEmittersnetworkConnectorEventHandlersnextClientIdnotifyClientConnectedonClientConnectonClientDisconnectonMessagerequestrequestRouterrequestssendMessagesubscribeunsubscribeHandleClientConnectMessageunsubscribeHandleEventMessageunsubscribeHandleRequestMessageunsubscribeHandleResponseMessagewebSocketServer
\ 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 041d49ec3e..387a47cd40 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

Class ExecutionToken

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

-

Constructors

constructor +

Constructors

constructor

Properties

name nonce type

Methods

getHash -

Constructors

constructor

Properties

Readonly name

name: string

Readonly nonce

nonce: string

Readonly type

type: "extension"

Methods

getHash

Settings

Member Visibility

Theme

On This Page

constructornamenoncetypegetHash
\ No newline at end of file +

Constructors

constructor

Properties

Readonly name

name: string

Readonly nonce

nonce: string

Readonly type

type: "extension"

Methods

getHash

Settings

Member Visibility

Theme

On This Page

constructornamenoncetypegetHash
\ 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 3a75d04382..64bd63e095 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

constructor +

Implements

  • WebSocket

Constructors

constructor

Properties

CLOSED CLOSING CONNECTING @@ -22,4 +22,4 @@ removeEventListener send url -

Constructors

constructor

Properties

Readonly CLOSED

CLOSED: 3

Readonly CLOSING

CLOSING: 2

Readonly CONNECTING

CONNECTING: 0

Readonly OPEN

OPEN: 1

addEventListener

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: BinaryType

bufferedAmount

bufferedAmount: number

close

close: ((code?, reason?) => void)

Type declaration

    • (code?, reason?): void

    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean

    • Parameters

      • event: Event

      Returns boolean

extensions

extensions: string

onclose

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

onerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

onmessage

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

onopen

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

protocol

protocol: string

readyState

readyState: number

removeEventListener

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

send: ((data) => void)

Type declaration

    • (data): void

    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url

url: string

Settings

Member Visibility

Theme

On This Page

constructorCLOSEDCLOSINGCONNECTINGOPENaddEventListenerbinaryTypebufferedAmountclosedispatchEventextensionsoncloseonerroronmessageonopenprotocolreadyStateremoveEventListenersendurl
\ No newline at end of file +

Constructors

constructor

Properties

Readonly CLOSED

CLOSED: 3

Readonly CLOSING

CLOSING: 2

Readonly CONNECTING

CONNECTING: 0

Readonly OPEN

OPEN: 1

addEventListener

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: BinaryType

bufferedAmount

bufferedAmount: number

close

close: ((code?, reason?) => void)

Type declaration

    • (code?, reason?): void

    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean

    • Parameters

      • event: Event

      Returns boolean

extensions

extensions: string

onclose

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

onerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

onmessage

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

onopen

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

protocol

protocol: string

readyState

readyState: number

removeEventListener

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

send: ((data) => void)

Type declaration

    • (data): void

    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url

url: string

Settings

Member Visibility

Theme

On This Page

constructorCLOSEDCLOSINGCONNECTINGOPENaddEventListenerbinaryTypebufferedAmountclosedispatchEventextensionsoncloseonerroronmessageonopenprotocolreadyStateremoveEventListenersendurl
\ 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 54faed3c36..92b49b97e4 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

constructor +

Implements

  • XMLHttpRequest

Constructors

constructor

Properties

DONE HEADERS_RECEIVED LOADING @@ -37,4 +37,4 @@ timeout upload withCredentials -

Constructors

constructor

Properties

Readonly DONE

DONE: 4

Readonly HEADERS_RECEIVED

HEADERS_RECEIVED: 2

Readonly LOADING

LOADING: 3

Readonly OPENED

OPENED: 1

Readonly UNSENT

UNSENT: 0

abort

abort: (() => void)

Type declaration

    • (): void

    • Returns void

addEventListener

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

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean

    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders

getAllResponseHeaders: (() => string)

Type declaration

    • (): string

    • Returns string

getResponseHeader

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

Type declaration

    • (name): null | string

    • Parameters

      • name: string

      Returns null | string

onabort

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onload

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onprogress

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onreadystatechange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

ontimeout

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

open

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

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void

    • Parameters

      • mime: string

      Returns void

readyState

readyState: number

removeEventListener

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

response: any

responseText

responseText: string

responseType

responseType: XMLHttpRequestResponseType

responseURL

responseURL: string

responseXML

responseXML: null | Document

send

send: ((body?) => void)

Type declaration

    • (body?): void

    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

setRequestHeader

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

Type declaration

    • (name, value): void

    • Parameters

      • name: string
      • value: string

      Returns void

status

status: number

statusText

statusText: string

timeout

timeout: number

upload

upload: XMLHttpRequestUpload

withCredentials

withCredentials: boolean

Settings

Member Visibility

Theme

On This Page

constructorDONEHEADERS_RECEIVEDLOADINGOPENEDUNSENTabortaddEventListenerdispatchEventgetAllResponseHeadersgetResponseHeaderonabortonerroronloadonloadendonloadstartonprogressonreadystatechangeontimeoutopenoverrideMimeTypereadyStateremoveEventListenerresponseresponseTextresponseTyperesponseURLresponseXMLsendsetRequestHeaderstatusstatusTexttimeoutuploadwithCredentials
\ No newline at end of file +

Constructors

constructor

Properties

Readonly DONE

DONE: 4

Readonly HEADERS_RECEIVED

HEADERS_RECEIVED: 2

Readonly LOADING

LOADING: 3

Readonly OPENED

OPENED: 1

Readonly UNSENT

UNSENT: 0

abort

abort: (() => void)

Type declaration

    • (): void

    • Returns void

addEventListener

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

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean

    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders

getAllResponseHeaders: (() => string)

Type declaration

    • (): string

    • Returns string

getResponseHeader

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

Type declaration

    • (name): null | string

    • Parameters

      • name: string

      Returns null | string

onabort

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onerror

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onload

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadend

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onloadstart

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onprogress

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

onreadystatechange

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

ontimeout

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

Type declaration

    • (this, ev): any

    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

open

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

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void

    • Parameters

      • mime: string

      Returns void

readyState

readyState: number

removeEventListener

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

response: any

responseText

responseText: string

responseType

responseType: XMLHttpRequestResponseType

responseURL

responseURL: string

responseXML

responseXML: null | Document

send

send: ((body?) => void)

Type declaration

    • (body?): void

    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

setRequestHeader

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

Type declaration

    • (name, value): void

    • Parameters

      • name: string
      • value: string

      Returns void

status

status: number

statusText

statusText: string

timeout

timeout: number

upload

upload: XMLHttpRequestUpload

withCredentials

withCredentials: boolean

Settings

Member Visibility

Theme

On This Page

constructorDONEHEADERS_RECEIVEDLOADINGOPENEDUNSENTabortaddEventListenerdispatchEventgetAllResponseHeadersgetResponseHeaderonabortonerroronloadonloadendonloadstartonprogressonreadystatechangeontimeoutopenoverrideMimeTypereadyStateremoveEventListenerresponseresponseTextresponseTyperesponseURLresponseXMLsendsetRequestHeaderstatusstatusTexttimeoutuploadwithCredentials
\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html index eb746a62f3..60a22e6271 100644 --- a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html @@ -6,6 +6,6 @@ 
this.notifyUpdate('Setting');

See

IBaseProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

notifyUpdate -

Constructors

constructor

Methods

notifyUpdate

Settings

Member Visibility

Theme

On This Page

constructornotifyUpdate
\ No newline at end of file +

Constructors

constructor

Methods

notifyUpdate

Settings

Member Visibility

Theme

On This Page

constructornotifyUpdate
\ 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 e6efa1b8e3..0f7c376909 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

constructor +

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Methods

notifyUpdate -

Constructors

constructor

Methods

notifyUpdate

Settings

Member Visibility

Theme

On This Page

constructornotifyUpdate
\ No newline at end of file +

Constructors

constructor

Methods

notifyUpdate

Settings

Member Visibility

Theme

On This Page

constructornotifyUpdate
\ 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 647fface40..2277cb23b0 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

constructor +

Type Parameters

  • T

Hierarchy

  • PlatformEventEmitter<T>
    • default

Constructors

constructor

Properties

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

Constructors

constructor

Properties

dispose

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

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

emit

emit: ((event) => void)

Type declaration

    • (event): void

    • Parameters

      • event: T

      Returns void

Private networkDisposer

networkDisposer: any

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

-

Private networkSubscriber

networkSubscriber: any

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

-

subscribe

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

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

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

emit

emit: ((event) => void)

Type declaration

    • (event): void

    • Parameters

      • event: T

      Returns void

Private networkDisposer

networkDisposer: any

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

+

Private networkSubscriber

networkSubscriber: any

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

+

subscribe

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

event

Accessors

event

Methods

Protected assertNotDisposed

Protected disposeFn

Methods

Protected assertNotDisposed

Protected disposeFn

Protected emitFn

Protected emitFn

emitLocal

emitLocal

Settings

Member Visibility

Theme

On This Page

constructordisposeemitnetworkDisposernetworkSubscribersubscribeeventassertNotDisposeddisposeFnemitFnemitLocal
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructordisposeemitnetworkDisposernetworkSubscribersubscribeeventassertNotDisposeddisposeFnemitFnemitLocal
\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html index f380b8fec4..23ba02bc5a 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html @@ -5,15 +5,15 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

-

Type Parameters

Constructors

constructor +

Type Parameters

Constructors

constructor

Properties

pdpfId pdpfIdRegexString projectInterfacesToLayerOver providedProjectInterfaces

Methods

getAvailableProjects

Constructors

constructor

Properties

pdpfId

pdpfId: string

Protected pdpfIdRegexString

pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

-

Abstract projectInterfacesToLayerOver

projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces +

Returns "shared/models/project-data-provider-engine-factory.model".LayeringProjectDataProviderEngineFactory<SupportedProjectInterfaces>

Properties

pdpfId

pdpfId: string

Protected pdpfIdRegexString

pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

+

Abstract projectInterfacesToLayerOver

projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included in the available projects this Layering PDPF @@ -32,13 +32,13 @@

  • Include one
  • Include both two and three.
    • -

    Abstract providedProjectInterfaces

    providedProjectInterfaces: SupportedProjectInterfaces

    The list of projectInterfaces that this layering PDPF provides on top of existing projects.

    +

    Abstract providedProjectInterfaces

    providedProjectInterfaces: SupportedProjectInterfaces

    The list of projectInterfaces that this layering PDPF provides on top of existing projects.

    Example

    providedProjectInterfaces: ['four', 'five'];

    This layering PDPF will announce that its provides the projectInterfaces four and five for projects that match projectInterfacesToLayerOver.

    -

    Methods

    getAvailableProjects

    Methods

    getAvailableProjects

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpdpfIdpdpfIdRegexStringprojectInterfacesToLayerOverprovidedProjectInterfacesgetAvailableProjects
    \ No newline at end of file +

    Parameters

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpdpfIdpdpfIdRegexStringprojectInterfacesToLayerOverprovidedProjectInterfacesgetAvailableProjects
    \ 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 afd649564a..62e9cefefa 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 @@ -6,6 +6,6 @@ 
    this.notifyUpdate('Setting');

    See

    IProjectDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    notifyUpdate -

    Constructors

    constructor

    Methods

    notifyUpdate

    Settings

    Member Visibility

    Theme

    On This Page

    constructornotifyUpdate
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    notifyUpdate

    Settings

    Member Visibility

    Theme

    On This Page

    constructornotifyUpdate
    \ 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 b4861849a2..db9b33f121 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

    Enumeration EntryType

    Type of file system item in a directory

    -

    Enumeration Members

    Directory +

    Enumeration Members

    Directory File Unknown -

    Enumeration Members

    Directory

    Directory: "directory"

    File

    File: "file"

    Unknown

    Unknown: "unknown"

    Settings

    Member Visibility

    Theme

    On This Page

    DirectoryFileUnknown
    \ No newline at end of file +

    Enumeration Members

    Directory

    Directory: "directory"

    File

    File: "file"

    Unknown

    Unknown: "unknown"

    Settings

    Member Visibility

    Theme

    On This Page

    DirectoryFileUnknown
    \ 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 02ee166e1c..2413718aee 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

    Enumeration ConnectionStatus

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

    -

    Enumeration Members

    Connected +

    Enumeration Members

    Connected Connecting Disconnected

    Enumeration Members

    Connected

    Connected: 2

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

    -

    Connecting

    Connecting: 1

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

    -

    Disconnected

    Disconnected: 0

    This connector is not connected to the network

    -

    Settings

    Member Visibility

    Theme

    On This Page

    ConnectedConnectingDisconnected
    \ No newline at end of file +

    Connecting

    Connecting: 1

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

    +

    Disconnected

    Disconnected: 0

    This connector is not connected to the network

    +

    Settings

    Member Visibility

    Theme

    On This Page

    ConnectedConnectingDisconnected
    \ 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 4c374bca34..f97e64e198 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

    Enumeration MessageType

    WebSocket message type that indicates how to handle it

    -

    Enumeration Members

    ClientConnect +

    Enumeration Members

    ClientConnect Event InitClient Request Response -

    Enumeration Members

    ClientConnect

    ClientConnect: "client-connect"

    Event

    Event: "event"

    InitClient

    InitClient: "init-client"

    Request

    Request: "request"

    Response

    Response: "response"

    Settings

    Member Visibility

    Theme

    On This Page

    ClientConnectEventInitClientRequestResponse
    \ No newline at end of file +

    Enumeration Members

    ClientConnect

    ClientConnect: "client-connect"

    Event

    Event: "event"

    InitClient

    InitClient: "init-client"

    Request

    Request: "request"

    Response

    Response: "response"

    Settings

    Member Visibility

    Theme

    On This Page

    ClientConnectEventInitClientRequestResponse
    \ 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 0c1b6b9435..7d9263626b 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

    Enumeration ProcessType

    Type of Paranext process

    -

    Enumeration Members

    ExtensionHost +

    Enumeration Members

    ExtensionHost Main Renderer -

    Enumeration Members

    ExtensionHost

    ExtensionHost: "extension-host"

    Main

    Main: "main"

    Renderer

    Renderer: "renderer"

    Settings

    Member Visibility

    Theme

    On This Page

    ExtensionHostMainRenderer
    \ No newline at end of file +

    Enumeration Members

    ExtensionHost

    ExtensionHost: "extension-host"

    Main

    Main: "main"

    Renderer

    Renderer: "renderer"

    Settings

    Member Visibility

    Theme

    On This Page

    ExtensionHostMainRenderer
    \ No newline at end of file diff --git a/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html b/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html index 9c20d6c250..9cd2e0b621 100644 --- a/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html +++ b/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html @@ -1,3 +1,3 @@ ElevatedPrivilegeNames | papi-dts

    Enumeration ElevatedPrivilegeNames

    String constants that are listed in an extension's manifest.json to state needed privileges

    -

    Enumeration Members

    manageExtensions -

    Enumeration Members

    manageExtensions

    manageExtensions: "manageExtensions"

    Settings

    Member Visibility

    Theme

    On This Page

    manageExtensions
    \ No newline at end of file +

    Enumeration Members

    manageExtensions +

    Enumeration Members

    manageExtensions

    manageExtensions: "manageExtensions"

    Settings

    Member Visibility

    Theme

    On This Page

    manageExtensions
    \ 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 75999286c2..06039f414d 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

    Enumeration WebViewContentType

    The type of code that defines a webview's content

    -

    Enumeration Members

    HTML +

    Enumeration Members

    HTML React URL

    Enumeration Members

    HTML

    HTML: "html"

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

    -

    React

    React: "react"

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

    React

    React: "react"

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

    -

    URL

    URL: "url"

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

    URL

    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.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    HTMLReactURL
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    HTMLReactURL
    \ 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 e45583e1d3..68372f76a9 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

    Args +

    Enumeration Members

    Args Complex Contents -

    Enumeration Members

    Args

    Args: "args"

    Complex

    Complex: "complex"

    Contents

    Contents: "contents"

    Settings

    Member Visibility

    Theme

    On This Page

    ArgsComplexContents
    \ No newline at end of file +

    Enumeration Members

    Args

    Args: "args"

    Complex

    Complex: "complex"

    Contents

    Contents: "contents"

    Settings

    Member Visibility

    Theme

    On This Page

    ArgsComplexContents
    \ 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 83529853c9..61a39514fb 100644 --- a/papi-dts/functions/__papi_backend_.fetch.html +++ b/papi-dts/functions/__papi_backend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    Function fetch

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

    • This is just an alias for internet.fetch

      -

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

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

    • This is just an alias for internet.fetch

      -

      Parameters

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

      Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

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

  • This is just an alias for internet.fetch

    +

    Parameters

    Returns Promise<Response>

    • Settings

    Member Visibility

    Theme

    \ 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 13632800b9..faadf4d3ab 100644 --- a/papi-dts/functions/__papi_frontend_.fetch.html +++ b/papi-dts/functions/__papi_frontend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    Function fetch

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

    • This is just an alias for internet.fetch

      -

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

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

    • This is just an alias for internet.fetch

      -

      Parameters

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

      Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

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

  • This is just an alias for internet.fetch

    +

    Parameters

    Returns Promise<Response>

    • Settings

    Member Visibility

    Theme

    \ 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 239621f50c..e38d1334bc 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

    Function createWebSocket

    • createWebSocket(url): Promise<WebSocket>

    • Creates a WebSocket for the renderer or extension host depending on where you're running

      Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ff73807078..23711c643b 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

    Function buildExtensionPathFromName

    • buildExtensionPathFromName(extensionName, fileName): string

    • Return a path to the specified file within the extension's installation directory

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    \ 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 a8119f70ad..19066fc617 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

    Function setExtensionUris

    • setExtensionUris(urisPerExtension): void

    • 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 75bc028609..5bc3a25e21 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>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 1def58f0a4..986ecb09ab 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

    Function createDir

    • createDir(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ce7532f4c9..9d3afd764e 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

    Function deleteDir

    • deleteDir(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 85f7fef040..6c150ed2bd 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

    Function deleteFile

    • deleteFile(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f71b00b789..089871373c 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html b/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html index 9f1647910e..2b885c2595 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html @@ -1,4 +1,4 @@ moveFile | papi-dts

    Function moveFile

    • moveFile(sourceUri, destinationUri): Promise<void>

    • Moves a file from one location to another

      Parameters

      • sourceUri: string

        The location of the file to move

      • destinationUri: string

        The uri where the file should be moved

        -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 17e6f69873..29e9e12b6c 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 89d40f1905..1fc69d9182 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

    Function readFileBinary

    • readFileBinary(uri): Promise<Buffer>

    • Read a binary file

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 c0255f9923..1531d23090 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

    Function readFileText

    • readFileText(uri): Promise<string>

    • Read a text file

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 780411076b..ce1d0feb5f 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

    Function touch

    • touch(uri, date): Promise<void>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d1ded88ab5..fbf6841d89 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 87822dcbcd..65d4d0a892 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

    Function createNonce

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3c5cc11eb8..04bd0cbcf4 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

    Function createUuid

    Settings

    Member Visibility

    Theme

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

    Function createUuid

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html index 8bece41496..6e188e914a 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html +++ b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html @@ -3,4 +3,4 @@
  • encodingType: "base64" | "base64url" | "binary" | "hex"

    String encoding to use for returning the binary hash value that is calculated

  • buffer: Buffer

    Raw data to be fed into the hash algorithm

    • Returns string

    String encoded value of the digest (https://csrc.nist.gov/glossary/term/hash_digest)

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 181166110b..03ec7f20e5 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

    Function getAppDir

    • getAppDir(this, ...args): string

    • 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

    clear +

    Parameters

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

    Returns string

    Properties

    clear

    Properties

    clear

    clear: (() => void)

    Type declaration

      • (): void

      • Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    clear
    \ 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 3c12b738fe..671a2064cb 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

    Function getPathFromUri

    • getPathFromUri(uri): string

    • Resolves the uri to a path

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html index 3577ed70a0..f9cbd5f5b9 100644 --- a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html +++ b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html @@ -1,3 +1,3 @@ isNoisyDevModeEnvVariableSet | papi-dts

    Function isNoisyDevModeEnvVariableSet

    • isNoisyDevModeEnvVariableSet(): boolean

    • Determines if running in noisy dev mode

      Returns boolean

      True if the process is running in noisy dev mode, false otherwise

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 c75a4f3ab0..dbf1bce803 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 eda1709d17..920b17dc14 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts

    Function resolveHtmlPath

    Settings

    Member Visibility

    Theme

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

    Function resolveHtmlPath

    Settings

    Member Visibility

    Theme

    \ 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 3634bb1472..1a79c7c4ef 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 7e0fe369de..8c8028a72b 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 73520887ac..73a5fe4f46 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b775aa4685..f8b1f67961 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])
    }

    Settings

    Member Visibility

    Theme

    \ 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])
    }

    Settings

    Member Visibility

    Theme

    \ 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 53d0221a85..7f220d5ec9 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 0a3d4af430..bf07b1dfb1 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e7be4067de..c078c79473 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 -
  • default<DialogTabType, DialogOptions>(dialogType, options, resolveCallback): ((optionOverrides?) => Promise<void>)

  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will +

  • default<DialogTabType, DialogOptions>(dialogType, options, resolveCallback): ((optionOverrides?) => Promise<void>)

  • 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
    • -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html index 0c9ba21070..e4e55ffa1d 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html @@ -15,4 +15,4 @@
  • localizedStrings: The current state of the localizations, either defaultState or the stored state on the papi, if any
    • -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 efe153c118..e52cf4006d 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?) => [ProjectInterfaceDataTypes[ProjectInterface][TDataType]["getData"], undefined | ((newData) => Promise<DataProviderUpdateInstructions<ProjectInterfaceDataTypes[ProjectInterface]>>), boolean])
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    \ 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 01ff812331..df0bb9e332 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 @@ -12,4 +12,4 @@

    Returns undefined | ProjectDataProviderInterfaces[ProjectInterface]

    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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 7f84e15765..c00d617f77 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 @@ -30,4 +30,4 @@

    Throws

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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 aa1998be69..306d720331 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d94b7a78ac..4a38ea1e90 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

    Function blockWebSocketsToPapiNetwork

    • blockWebSocketsToPapiNetwork(): void

    • Once our network is running, run this to stop extensions from connecting to it directly

      -

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 26c4b19819..7187da99f3 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

    Function getDataProviderDataTypeFromFunctionName

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html index 3d5dd56627..f1814bafad 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html @@ -5,4 +5,4 @@

    Parameters

    Returns -1 | 0 | 1

    -1 if a is less than b, 0 if equal, and 1 otherwise

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html index f683c149d7..44db96753d 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html @@ -1,4 +1,4 @@ getPDPFactoryIdFromNetworkObjectName | papi-dts

    Function getPDPFactoryIdFromNetworkObjectName

    • getPDPFactoryIdFromNetworkObjectName(pdpFactoryNetworkObjectName): string

    • Transform a network object id for a pdp factory into its well-known pdp factory id

      Parameters

      • pdpFactoryNetworkObjectName: string

        Id for then network object for this pdp factory

      Returns string

      Id extensions use to identify this pdp factory

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html index 6b926a48f2..5ab99f7ee1 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html @@ -1,4 +1,4 @@ getPDPFactoryNetworkObjectNameFromId | papi-dts

    Function getPDPFactoryNetworkObjectNameFromId

    • getPDPFactoryNetworkObjectNameFromId(pdpFactoryId): string

    • Transform the well-known pdp factory id into an id for its network object to use

      Parameters

      • pdpFactoryId: string

        Id extensions use to identify this pdp factory

      Returns string

      Id for then network object for this pdp factory

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html index 07bba2f9df..3a06b21442 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html @@ -3,4 +3,4 @@ provided by the PDP Factory with the matching id (or all PDP Factories if no id is specified) for the project will be returned. If you need projectInterfaces supported by specific PDP Factories, you can access it at ProjectMetadata.pdpFactoryInfo.

    -

    Parameters

    Returns Promise<ProjectMetadata[]>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Promise<ProjectMetadata[]>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html index 51a2a87707..a80de73abc 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html @@ -1 +1 @@ -transformGetMetadataForProjectParametersToFilter | papi-dts

    Function transformGetMetadataForProjectParametersToFilter

    • transformGetMetadataForProjectParametersToFilter(projectId?, projectInterface?, pdpFactoryId?): {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

    • Parameters

      • Optional projectId: string
      • Optional projectInterface: keyof ProjectDataProviderInterfaces
      • Optional pdpFactoryId: string

      Returns {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined

    Settings

    Member Visibility

    Theme

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

    Function transformGetMetadataForProjectParametersToFilter

    • transformGetMetadataForProjectParametersToFilter(projectId?, projectInterface?, pdpFactoryId?): {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

    • Parameters

      • Optional projectId: string
      • Optional projectInterface: keyof ProjectDataProviderInterfaces
      • Optional pdpFactoryId: string

      Returns {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined

    Settings

    Member Visibility

    Theme

    \ 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 84f9958893..979fc77241 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ca9505a997..e5e81c3294 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

    Function initialize

    • initialize(): Promise<void>

    • Sets up the CommandService. Only runs once and always returns the same promise after that

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 4883a25715..551bbf6233 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f3d74cd1a9..515085a32c 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

    Function sendCommand

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    \ 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 f7abbcff89..d9d821d556 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 940e6db711..ee5f278f0b 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

    Function disconnect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 642e91bb34..1d760b1f2a 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>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 5bde08615d..11726cc24a 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

    Function getClientId

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ 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 d1586bb955..2fcffa9518 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 264aa4a64c..f375a3e09e 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

    Function getByType

    • getByType<T>(providerName): Promise<T | undefined>

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d427e7a298..45a4f61581 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 17cf5eb499..c56b939b03 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 0be73696cf..39a4741ba1 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

    Function createNetworkConnector

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 dcad724629..6ba50feef6 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

    Function onDidCreateNetworkObject

    • onDidCreateNetworkObject(callback): Unsubscriber

    • 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ 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 5b401bdd41..3b58415563 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

    Function onDidDisposeNetworkObject

    • onDidDisposeNetworkObject(callback): Unsubscriber

    • Event that fires with a network object ID when that object is disposed locally or remotely

      -

      Parameters

      • callback: PlatformEventHandler<string>

      Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ 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 5b7f8e1e74..de302a6f01 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

    Function overrideDispose

    • overrideDispose(objectToMutate, newDispose): void

    • If dispose already exists on objectToMutate, we will call it in addition to newDispose

      -

      Parameters

      • objectToMutate: IDisposableObject
      • newDispose: UnsubscriberAsync

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 0131285cd3..da86e0c7bc 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e3b1b1b98d..49208b8241 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3aea4a2b72..1de6a7e79e 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

    Function getNetworkEvent

    • getNetworkEvent<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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 dae29f0098..3cf2f75cbb 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

    Function initialize

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 420f39290f..8675f404e0 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

    Function onDidClientConnect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ 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 7c0a9689ce..b25cbada7d 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

    Function onDidClientDisconnect

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Settings

    Member Visibility

    Theme

    \ 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 8e14878d51..82a263bc61 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

    -
  • registerRequestHandler(requestType, handler, handlerType?): Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • registerRequestHandler(requestType, handler, handlerType?): Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • registerRequestHandler(requestType, handler, handlerType?): Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • registerRequestHandler(requestType, handler, handlerType?): Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

    • Settings

    Member Visibility

    Theme

    \ 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 c0f14add3b..d7246a2204 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 4da20401e4..a7b2466fee 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

    Function shutdown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 45175d9bfa..b4855d6672 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 @@ -12,4 +12,4 @@

    Throws

    If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d7c64717fc..63f4ba3a0c 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 @@ -5,4 +5,4 @@ should be available on the PDPEs created by this factory.

  • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

    Used in a ProjectDataProviderFactory to create ProjectDataProviders

    • Returns Promise<Dispose>

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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 c7ad376a0a..970241dd79 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

    Function getProcessType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 bf63445779..1c47466bc7 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

    Function isClient

    • isClient(): boolean

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 c5cd57568d..9f96f51d66 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

    Function isExtensionHost

    • isExtensionHost(): boolean

    • Determine if running on the extension host

      Returns boolean

      Returns true if running on the extension host, false otherwise

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e4515c15ea..1006f4af49 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

    Function isRenderer

    • isRenderer(): boolean

    • Determine if running on the renderer process

      Returns boolean

      Returns true if running on the renderer, false otherwise

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ea24ef80b7..87e32548b9 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

    Function isServer

    • isServer(): boolean

    • Determine if running on the server process (main)

      Returns boolean

      Returns true if running on the server, false otherwise

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 91d812d967..a5673ab102 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)

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 853c45f341..67b5f68ce3 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

    Function deserializeRequestType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns RequestType

    Settings

    Member Visibility

    Theme

    \ 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 b5055c388e..9295c5a3b3 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

    Function getModuleSimilarApiMessage

    • getModuleSimilarApiMessage(moduleName): string

    • 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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 64d7f99c38..d32be85bd4 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    \ 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 27fa8927d5..b1a0e66741 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/getSavedWebViewDefinition.html b/papi-dts/functions/getSavedWebViewDefinition.html index ff4784de15..06dc701087 100644 --- a/papi-dts/functions/getSavedWebViewDefinition.html +++ b/papi-dts/functions/getSavedWebViewDefinition.html @@ -1,4 +1,4 @@ getSavedWebViewDefinition | papi-dts

    Function getSavedWebViewDefinition

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns undefined | SavedWebViewDefinition

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/getSavedWebViewDefinitionById.html b/papi-dts/functions/getSavedWebViewDefinitionById.html index d3674a0674..b1e6069693 100644 --- a/papi-dts/functions/getSavedWebViewDefinitionById.html +++ b/papi-dts/functions/getSavedWebViewDefinitionById.html @@ -1 +1 @@ -getSavedWebViewDefinitionById | papi-dts

    Function getSavedWebViewDefinitionById

    Settings

    Member Visibility

    Theme

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

    Function getSavedWebViewDefinitionById

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index 335f97c91c..826e1c404a 100644 --- a/papi-dts/functions/getWebViewState.html +++ b/papi-dts/functions/getWebViewState.html @@ -1,3 +1,3 @@ getWebViewState | papi-dts

    Function getWebViewState

    • getWebViewState<T>(stateKey, defaultValue): T

    • 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index 7830121fbf..66c1001831 100644 --- a/papi-dts/functions/resetWebViewState.html +++ b/papi-dts/functions/resetWebViewState.html @@ -1,2 +1,2 @@ resetWebViewState | papi-dts

    Function resetWebViewState

    • resetWebViewState(stateKey): void

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

      -

      Parameters

      • stateKey: string

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 44f6992430..57f59b13d8 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    Function setWebViewState

    • setWebViewState<T>(stateKey, stateValue): void

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index 15a667ac3e..b0e0e1207a 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -6,4 +6,4 @@

    ＠example

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

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

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

    Function updateWebViewDefinitionById

    Settings

    Member Visibility

    Theme

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

    Function updateWebViewDefinitionById

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index bfda7bdfaa..d9e03f415e 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)]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index 9e5a667512..175abf4cce 100644 --- a/papi-dts/functions/webViewComponent.html +++ b/papi-dts/functions/webViewComponent.html @@ -1,6 +1,6 @@ webViewComponent | papi-dts

    Function webViewComponent

    • webViewComponent(props, context?): ReactNode

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

      -

      Parameters

      Returns ReactNode

    Properties

    contextTypes? +

    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 6e44fdc897..a4aa54072f 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,10 +1,10 @@ IExtension | papi-dts

    Interface IExtension

    Interface for all extensions to implement

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

    Properties

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

    Properties

    activate deactivate?

    Properties

    activate

    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

    Type declaration

      • (context): Promise<void>

      • Parameters

        Returns Promise<void>

    Optional deactivate

    deactivate?: UnsubscriberAsync

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

    Returns Promise<void>

    Optional deactivate

    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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    activatedeactivate
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    activatedeactivate
    \ 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 f74f41df00..3c57b171de 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

    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

    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 readBinaryFileFromInstallDirectory readTextFileFromInstallDirectory readUserData @@ -8,23 +8,23 @@

    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

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

    Type declaration

      • (token, fileName): Promise<Buffer>

      • Read a binary file from the the extension's installation directory

        +

    readBinaryFileFromInstallDirectory

    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

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

    Type declaration

      • (token, fileName): Promise<string>

      • Read a text file from the the extension's installation directory

        +

    readTextFileFromInstallDirectory

    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

    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

    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

    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

    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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    deleteUserDatareadBinaryFileFromInstallDirectoryreadTextFileFromInstallDirectoryreadUserDatawriteUserData
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    deleteUserDatareadBinaryFileFromInstallDirectoryreadTextFileFromInstallDirectoryreadUserDatawriteUserData
    \ 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 df7cba8c04..1aebfc3805 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -6,11 +6,11 @@ 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.throwError: ((message) => void);
        test.throwErrorExtensionHost: ((message) => void);
    }

    Properties

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

    Properties

    platform.quit platform.restartExtensionHost test.addMany test.echo test.echoExtensionHost test.throwError test.throwErrorExtensionHost -

    Properties

    platform.quit

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    platform.restartExtensionHost

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    test.addMany

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

    Type declaration

      • (...nums): number

      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo

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

    Type declaration

      • (message): string

      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    platform.quitplatform.restartExtensionHosttest.addManytest.echotest.echoExtensionHosttest.throwErrortest.throwErrorExtensionHost
    \ No newline at end of file +

    Properties

    platform.quit

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    platform.restartExtensionHost

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

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    test.addMany

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

    Type declaration

      • (...nums): number

      • Parameters

        • Rest ...nums: number[]

        Returns number

    test.echo

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

    Type declaration

      • (message): string

      • Parameters

        • message: string

        Returns string

    test.echoExtensionHost

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

    Type declaration

      • (message): Promise<string>

      • Parameters

        • message: string

        Returns Promise<string>

    test.throwError

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    test.throwErrorExtensionHost

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

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    platform.quitplatform.restartExtensionHosttest.addManytest.echotest.echoExtensionHosttest.throwErrortest.throwErrorExtensionHost
    \ 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 8a8c4c3634..5bc97b1cff 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>;
    }

    Properties

    platform.placeholder +
    interface DataProviders {
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>;
        platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>;
    }

    Properties

    platform.placeholder platform.stuff -

    Properties

    platform.placeholder

    platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>

    platform.stuff

    platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.placeholderplatform.stuff
    \ No newline at end of file +

    Properties

    platform.placeholder

    platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>

    platform.stuff

    platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.placeholderplatform.stuff
    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html index ea942d97b3..00d575cce9 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html @@ -33,10 +33,10 @@ MyExtensionLayeringProjectInterface projectInterface):

    Example

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

      export type MyLayeringProjectDataTypes = {
        MyOtherProjectData: DataProviderDataType<number, number, number>;
      };

      export interface ProjectDataProviderInterfaces {
        // Note that the base PDP implements `I**Base**ProjectDataProvider`
        MyExtensionBaseProjectInterface: IBaseProjectDataProvider<MyProjectDataTypes>;
        // Note that the layering PDP only implements `IProjectDataProvider` because the base PDP already
        // provides the `platform.base` data types
        MyExtensionLayeringProjectInterface: IProjectDataProvider<MyLayeringProjectDataTypes>;
      }
    }
    -
    interface ProjectDataProviderInterfaces {
        platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>;
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    platform.base +
    interface ProjectDataProviderInterfaces {
        platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>;
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    platform.base platform.notesOnly platform.placeholder

    Properties

    platform.base

    platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>

    Base projectInterface that all PDPs that expose their own unique project ids must implement.

    There should be a PDP that provides platform.base for all available project ids.

    -

    platform.notesOnly

    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>

    platform.placeholder

    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.baseplatform.notesOnlyplatform.placeholder
    \ No newline at end of file +

    platform.notesOnly

    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>

    platform.placeholder

    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.baseplatform.notesOnlyplatform.placeholder
    \ 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 182fa4cd1b..0092bfebdc 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -9,22 +9,22 @@ 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.isEditable: boolean;
        platform.language: string;
        platform.name: string;
    }

    Properties

    platform.fullName +
    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.isEditable: boolean;
        platform.language: string;
        platform.name: string;
    }

    Properties

    platform.fullName platform.isEditable platform.language platform.name

    Properties

    platform.fullName

    platform.fullName: string

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

    Example

    'World English Bible'
    -

    platform.isEditable

    platform.isEditable: boolean

    Whether or not the project is editable. This is a general "editable", not necessarily that it +

    platform.isEditable

    platform.isEditable: boolean

    Whether or not the project is editable. This is a general "editable", not necessarily that it is editable by the current user.

    Projects that are not editable are sometimes called "resources".

    -

    platform.language

    platform.language: string

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

    platform.language

    platform.language: string

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

    Example

    'English'
    -

    platform.name

    platform.name: string

    Short name of the project (not necessarily unique). This will be displayed directly in the +

    platform.name

    platform.name: string

    Short name of the project (not necessarily unique). This will be displayed directly in the UI.

    Example

    'WEB'
    -

    Settings

    Member Visibility

    Theme

    On This Page

    platform.fullNameplatform.isEditableplatform.languageplatform.name
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    platform.fullNameplatform.isEditableplatform.languageplatform.name
    \ 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 5ccddc6cc6..651a2e47ff 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

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

    Properties

    platform.interfaceLanguage platform.verseRef -

    Properties

    platform.interfaceLanguage

    platform.interfaceLanguage: string[]

    platform.verseRef

    platform.verseRef: ScriptureReference

    Settings

    Member Visibility

    Theme

    On This Page

    platform.interfaceLanguageplatform.verseRef
    \ No newline at end of file +

    Properties

    platform.interfaceLanguage

    platform.interfaceLanguage: string[]

    platform.verseRef

    platform.verseRef: ScriptureReference

    Settings

    Member Visibility

    Theme

    On This Page

    platform.interfaceLanguageplatform.verseRef
    \ 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 385fa7661c..5c6142f57f 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,7 +1,7 @@ DialogTypes | papi-dts

    Interface DialogTypes

    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

    -
    interface DialogTypes {
        platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>;
        platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>;
        platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>;
    }

    Properties

    platform.selectBooks +
    interface DialogTypes {
        platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>;
        platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>;
        platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>;
    }

    Properties

    platform.selectBooks platform.selectMultipleProjects platform.selectProject -

    Properties

    platform.selectBooks

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.selectBooksplatform.selectMultipleProjectsplatform.selectProject
    \ No newline at end of file +

    Properties

    platform.selectBooks

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>

    platform.selectMultipleProjects

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

    platform.selectProject

    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Settings

    Member Visibility

    Theme

    On This Page

    platform.selectBooksplatform.selectMultipleProjectsplatform.selectProject
    \ 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 00cd3f8441..a56480e599 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

    Interface FloatLayout

    Information about a floating window

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

    Properties

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

    Properties

    floatSize? position? type -

    Properties

    Optional floatSize

    floatSize?: FloatSize

    Optional position

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -

    type

    type: "float"

    Settings

    Member Visibility

    Theme

    On This Page

    floatSizepositiontype
    \ No newline at end of file +

    Properties

    Optional floatSize

    floatSize?: FloatSize

    Optional position

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +

    type

    type: "float"

    Settings

    Member Visibility

    Theme

    On This Page

    floatSizepositiontype
    \ 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 bc3f4eb1b8..7a29aca3c6 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

    Interface PanelLayout

    Information about a panel

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

    Properties

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

    Properties

    direction? targetTabId? type -

    Properties

    Optional direction

    direction?: PanelDirection

    Optional targetTabId

    targetTabId?: string

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

    -

    type

    type: "panel"

    Settings

    Member Visibility

    Theme

    On This Page

    directiontargetTabIdtype
    \ No newline at end of file +

    Properties

    Optional direction

    direction?: PanelDirection

    Optional targetTabId

    targetTabId?: string

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

    +

    type

    type: "panel"

    Settings

    Member Visibility

    Theme

    On This Page

    directiontargetTabIdtype
    \ 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 6b6f87b350..06863fc565 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

    Interface TabLayout

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    type -

    Properties

    type

    type: "tab"

    Settings

    Member Visibility

    Theme

    On This Page

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

    Properties

    type +

    Properties

    type

    type: "tab"

    Settings

    Member Visibility

    Theme

    On This Page

    type
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index ae6690de3f..5e2ff48afa 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html @@ -1,5 +1,5 @@ -NetworkObjectStatusRemoteServiceType | papi-dts

    Interface NetworkObjectStatusRemoteServiceType

    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts

    Interface NetworkObjectStatusRemoteServiceType

    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails

    Properties

    getAllNetworkObjectDetails

    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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    getAllNetworkObjectDetails
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getAllNetworkObjectDetails
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html index 7bc1e88dda..1a44c986aa 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html @@ -1,10 +1,10 @@ NetworkObjectStatusServiceType | papi-dts

    Interface NetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails waitForNetworkObject

    Properties

    getAllNetworkObjectDetails

    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

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

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

    +

    waitForNetworkObject

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

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

    Type declaration

      • (objectDetailsToMatch, timeoutInMS?): Promise<NetworkObjectDetails>

      • Parameters

        • objectDetailsToMatch: Partial<NetworkObjectDetails>

          Subset of object details on the network object to wait for. Compared to object details using isSubset

        • Optional timeoutInMS: number

          Max duration to wait for the network object. If not provided, it will wait @@ -12,4 +12,4 @@

        Returns Promise<NetworkObjectDetails>

    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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    getAllNetworkObjectDetailswaitForNetworkObject
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getAllNetworkObjectDetailswaitForNetworkObject
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html index 3fc3e0dc7e..220d351a63 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html @@ -20,7 +20,7 @@

    To make creating a Layering PDPF easier, you can extend LayeringProjectDataProviderEngineFactory, which automatically fulfills the special requirements for Layering PDPFs. We highly recommend using it.

    -
    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    createProjectDataProviderEngine +
    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    createProjectDataProviderEngine getAvailableProjects

    Methods

    createProjectDataProviderEngine

    getAvailableProjects

    getAvailableProjects

    • getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>

    • Get metadata about all projects that can be served by PDPs created by this PDP factory.

      If this is a Base PDP Factory, this method should return this PDP Factory's own unique project IDs.

      If this is a Layering PDP Factory, this method should call @@ -46,4 +46,4 @@ calling papi.projectLookup.getMetadataForAllProjects inside this method. If you are not calling getMetadataForAllProjects inside this method (likely if this is a Base PDPF), you can safely ignore this parameter.

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Settings

    Member Visibility

    Theme

    On This Page

    createProjectDataProviderEnginegetAvailableProjects
    \ No newline at end of file +

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Settings

    Member Visibility

    Theme

    On This Page

    createProjectDataProviderEnginegetAvailableProjects
    \ 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 0b7b2544f9..44a622f438 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 @@ -6,11 +6,11 @@ and provide additional projectInterfaces on those projects (Layering PDP Factory). Base PDP Factories must create PDPs that support the platform.base projectInterface. See IBaseProjectDataProvider and ProjectDataProviderInterfaces for more information.

    -
    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId): Promise<string>;
    }

    Hierarchy

    Properties

    dispose +
    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId): Promise<string>;
    }

    Hierarchy

    • Dispose
      • default

    Properties

    dispose

    Methods

    getAvailableProjects getProjectDataProviderId

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

    getAvailableProjects

    Methods

    getAvailableProjects

    • getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>

    • Get metadata about all projects that can be served by PDPs created by this PDP factory.

      If this is a Base PDP Factory, this method should return this PDP Factory's own unique project IDs.

      If this is a Layering PDP Factory, this method should call @@ -28,11 +28,11 @@ calling papi.projectLookup.getMetadataForAllProjects inside this method. If you are not calling getMetadataForAllProjects inside this method (likely if this is a Base PDPF), you can safely ignore this parameter.

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    getProjectDataProviderId

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    getProjectDataProviderId

    Settings

    Member Visibility

    Theme

    On This Page

    disposegetAvailableProjectsgetProjectDataProviderId
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    disposegetAvailableProjectsgetProjectDataProviderId
    \ 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 bc4500234b..df631976eb 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

    Interface DisposableWebViewProvider

    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

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

    Hierarchy (view full)

    Properties

    dispose onDidDispose

    Methods

    getWebView

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ 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 347bafdd82..1af6a11c55 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

    Interface IWebViewProvider

    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

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

    Hierarchy (view full)

    Properties

    dispose? onDidDispose?

    Methods

    getWebView

    Properties

    Optional dispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Optional onDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    Optional onDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ 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 abf783659b..31001c6343 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

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

    Hierarchy (view full)

    Properties

    dispose? onDidDispose

    Methods

    getWebView

    Properties

    Optional dispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ No newline at end of file +
  • getWebViewOptions: GetWebViewOptions

    • Returns Promise<undefined | WebViewDefinition>

    Settings

    Member Visibility

    Theme

    On This Page

    disposeonDidDisposegetWebView
    \ 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 facb956246..564f1b9fd0 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

    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

    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

    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

    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.

      @@ -36,13 +36,13 @@

      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

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

    Get a data provider that has previously been set up

    +

    get

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

    Get a data provider that has previously been set up

    Type declaration

    Returns

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

    -

    hasKnown

    hasKnown: ((providerName) => boolean)

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

    hasKnown

    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

      • Parameters

        • providerName: string

        Returns boolean

    registerEngine

    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 +

    Type declaration

      • (providerName): boolean

      • Parameters

        • providerName: string

        Returns boolean

    registerEngine

    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

    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.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    DataProviderEnginedecoratorsgethasKnownregisterEngine
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    DataProviderEnginedecoratorsgethasKnownregisterEngine
    \ 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 92c9c389ec..142903f176 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

    Interface DialogService

    Prompt the user for responses with dialogs

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

    Methods

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

    Methods

    selectProject showDialog

    Methods

    selectProject

    • selectProject(options?): Promise<undefined | string>

    • 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

      -

    showDialog

    showDialog

    Settings

    Member Visibility

    Theme

    On This Page

    selectProjectshowDialog
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    selectProjectshowDialog
    \ 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 5e96a7250b..8d7aa2185e 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

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

    Properties

    fetch +InternetService | papi-dts

    Interface InternetService

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

    Properties

    fetch

    Properties

    fetch

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

    Type declaration

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

      • MDN Reference

        -

        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>

    Settings

    Member Visibility

    Theme

    On This Page

    fetch
    \ 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>

    • Settings

    Member Visibility

    Theme

    On This Page

    fetch
    \ 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 d8dfe7adb9..3117383255 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 default

    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

    connect +
    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 @@ -24,23 +24,23 @@
  • networkConnectorEventHandlers: NetworkConnectorEventHandlers

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

    • Returns Promise<Readonly<{
        clientId: number;
    }>>

    Returns

    Promise that resolves with connector info when finished connecting

    -

    connectionStatus

    connectionStatus: ConnectionStatus

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

    connectionStatus

    connectionStatus: ConnectionStatus

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

    -

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

    • clientId: number

    disconnect

    disconnect: (() => void)

    Disconnects from the connection:

    +

    connectorInfo

    connectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

    • clientId: number

    disconnect

    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

    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

    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

        • eventType: string

          Unique network event type for coordinating between processes

        • event: InternalEvent<T>

          Event to emit on the network

          -

        Returns Promise<void>

    notifyClientConnected

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

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

    +

    Returns Promise<void>

    notifyClientConnected

    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

    request

    request: InternalRequestHandler

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

    +

    Type declaration

    request

    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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    connectconnectionStatusconnectorInfodisconnectemitEventOnNetworknotifyClientConnectedrequest
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    connectconnectionStatusconnectorInfodisconnectemitEventOnNetworknotifyClientConnectedrequest
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html b/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html index f284218ca1..d9ed6e969d 100644 --- a/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html +++ b/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html @@ -1,4 +1,4 @@ -MinimalNetworkObjectService | papi-dts

    Interface MinimalNetworkObjectService

    interface MinimalNetworkObjectService {
        get: (<T>(id, createLocalObjectToProxy?) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +MinimalNetworkObjectService | papi-dts

    Interface MinimalNetworkObjectService

    interface MinimalNetworkObjectService {
        get: (<T>(id, createLocalObjectToProxy?) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get onDidCreateNetworkObject set

    Properties

    get

    get: (<T>(id, createLocalObjectToProxy?) => Promise<undefined | NetworkObject<T>>)

    Type declaration

      • <T>(id, createLocalObjectToProxy?): Promise<undefined | NetworkObject<T>>

      • Get a network object that has previously been set up to be shared on the network. A network @@ -10,7 +10,7 @@ will be based upon. The object this function creates cannot have an onDidDispose property. This function is useful for setting up network events on a network object.

    Returns Promise<undefined | NetworkObject<T>>

    A promise for the network object with specified ID if one exists, undefined otherwise

    -

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

    set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        +

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

    set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        Type Parameters

        Parameters

        • id: string

          ID of the object to share on the network. All processes must use this ID to look it up.

        • objectToShare: T

          The object to set up as a network object. It will have an event named onDidDispose added to its properties. An error will be thrown if the object already had an @@ -19,4 +19,4 @@ object did not already define a dispose function, one will be added.

          WARNING: setting a network object mutates the provided object.

        • Optional objectType: string
        • Optional objectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -

    Settings

    Member Visibility

    Theme

    On This Page

    getonDidCreateNetworkObjectset
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getonDidCreateNetworkObjectset
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html b/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html index 3937d54662..6216a564f9 100644 --- a/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html +++ b/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html @@ -1,4 +1,4 @@ -NetworkObjectService | papi-dts

    Interface NetworkObjectService

    interface NetworkObjectService {
        get: (<T>(id, createLocalObjectToProxy?) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +NetworkObjectService | papi-dts

    Interface NetworkObjectService

    interface NetworkObjectService {
        get: (<T>(id, createLocalObjectToProxy?) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get hasKnown initialize onDidCreateNetworkObject @@ -12,12 +12,12 @@ will be based upon. The object this function creates cannot have an onDidDispose property. This function is useful for setting up network events on a network object.

    Returns Promise<undefined | NetworkObject<T>>

    A promise for the network object with specified ID if one exists, undefined otherwise

    -

    hasKnown

    hasKnown: ((id) => boolean)

    Type declaration

      • (id): boolean

      • Search locally known network objects for the given ID. Don't look on the network for more +

    hasKnown

    hasKnown: ((id) => boolean)

    Type declaration

      • (id): boolean

      • Search locally known network objects for the given ID. Don't look on the network for more objects.

        Parameters

        • id: string

        Returns boolean

        Whether we know of an existing network object with the provided ID already on the network

        -

    initialize

    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>

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

    set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        +

    initialize

    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>

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

    set: (<T>(id, objectToShare, objectType?, objectAttributes?) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        Type Parameters

        Parameters

        • id: string

          ID of the object to share on the network. All processes must use this ID to look it up.

        • objectToShare: T

          The object to set up as a network object. It will have an event named onDidDispose added to its properties. An error will be thrown if the object already had an @@ -26,4 +26,4 @@ object did not already define a dispose function, one will be added.

          WARNING: setting a network object mutates the provided object.

        • Optional objectType: string
        • Optional objectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -

    Settings

    Member Visibility

    Theme

    On This Page

    gethasKnowninitializeonDidCreateNetworkObjectset
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    gethasKnowninitializeonDidCreateNetworkObjectset
    \ 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 b9fe6fcabb..772d863155 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

    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

    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

    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

    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

    onDidClientConnect: PlatformEvent<ClientConnectEvent>

    onDidClientDisconnect

    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>

    Settings

    Member Visibility

    Theme

    On This Page

    createNetworkEventEmittergetNetworkEventonDidClientConnectonDidClientDisconnect
    \ No newline at end of file +

    onDidClientConnect

    onDidClientConnect: PlatformEvent<ClientConnectEvent>

    onDidClientDisconnect

    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>

    Settings

    Member Visibility

    Theme

    On This Page

    createNetworkEventEmittergetNetworkEventonDidClientConnectonDidClientDisconnect
    \ 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 3819999aa1..45699dbd46 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

    interface PapiBackendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts

    Interface PapiBackendProjectDataProviderService

    interface PapiBackendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

    get registerProjectDataProviderEngineFactory

    Properties

    get

    get: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>)

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>

      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

          projectInterface that the project to load must support. The TypeScript @@ -14,11 +14,11 @@

          Throws

          If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

          -

    registerProjectDataProviderEngineFactory

    registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory) => Promise<Dispose>)

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>

      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        +

    registerProjectDataProviderEngineFactory

    registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory) => Promise<Dispose>)

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>

      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        Type Parameters

        Parameters

        • pdpFactoryId: string

          Unique id for this PDP factory

        • projectInterfaces: SupportedProjectInterfaces

          The standardized sets of methods (projectInterfaces) supported by the Project Data Provider Engines produced by this factory. Indicates what sort of project data should be available on the PDPEs created by this factory.

        • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

          Used in a ProjectDataProviderFactory to create ProjectDataProviders

        Returns Promise<Dispose>

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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    getregisterProjectDataProviderEngineFactory
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getregisterProjectDataProviderEngineFactory
    \ 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 a09d110d05..b21f2c2469 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

    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts

    Interface PapiFrontendProjectDataProviderService

    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

    get

    Properties

    get

    get: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>)

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>

      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

          projectInterface that the project to load must support. The TypeScript type for the returned project data provider will have the project data provider interface type @@ -13,4 +13,4 @@

          Throws

          If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

          -

    Settings

    Member Visibility

    Theme

    On This Page

    get
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    get
    \ 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 f014b49df4..44e0bc3de5 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,5 +1,5 @@ IProjectSettingsService | papi-dts

    Interface IProjectSettingsService

    Provides utility functions that project data providers should call when handling project settings

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

    Methods

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

    Methods

    getDefault isValid registerValidator

    Methods

    getDefault

    isValid

    isValid

    • isValid<ProjectSettingName>(key, newValue, currentValue, allChanges?): Promise<boolean>

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

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

      @@ -19,7 +19,7 @@
    • currentValue: ProjectSettingTypes[ProjectSettingName]

      The current project setting value

    • Optional allChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -

    registerValidator

    registerValidator

    Settings

    Member Visibility

    Theme

    On This Page

    getDefaultisValidregisterValidator
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getDefaultisValidregisterValidator
    \ 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 f200100113..f8bbb03648 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

    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    register +PapiWebViewProviderService | papi-dts

    Interface PapiWebViewProviderService

    interface PapiWebViewProviderService {
        register: ((webViewType, webViewProvider) => Promise<DisposableWebViewProvider>);
    }

    Properties

    register

    Properties

    register

    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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    register
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    register
    \ 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 daba20109c..06dad9f8c4 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

    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

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

    Properties

    get hasKnown initialize register

    Properties

    get

    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

    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

    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

    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

    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

    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

    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

        -

    Settings

    Member Visibility

    Theme

    On This Page

    gethasKnowninitializeregister
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    gethasKnowninitializeregister
    \ 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 0677198211..45e9fccbb4 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

    Interface 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.

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

    Properties

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

    Properties

    getWebView onDidAddWebView

    Methods

    getSavedWebViewDefinition

    Properties

    getWebView

    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 @@ -13,8 +13,8 @@

    Returns Promise<undefined | string>

    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

    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -

    Methods

    getSavedWebViewDefinition

    onDidAddWebView

    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    +

    Methods

    getSavedWebViewDefinition

    • getSavedWebViewDefinition(webViewId): Promise<undefined | SavedWebViewDefinition>

    • Gets the saved properties on the WebView definition with the specified ID

      Note: this only returns a representation of the current web view definition, not the actual web view definition itself. Changing properties on the returned definition does not affect the actual web view definition. You can possibly change the actual web view definition by calling @@ -23,4 +23,4 @@

      Throws

      If something went wrong like the provider for the webViewType

      Parameters

      • webViewId: string

        The ID of the WebView whose saved properties to get

      Returns Promise<undefined | SavedWebViewDefinition>

      Saved properties of the WebView definition with the specified ID or undefined if not found

      -

    Settings

    Member Visibility

    Theme

    On This Page

    getWebViewonDidAddWebViewgetSavedWebViewDefinition
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getWebViewonDidAddWebViewgetSavedWebViewDefinition
    \ No newline at end of file diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index f1a795b5b4..375d675d6e 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

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

    Namespace "@papi/backend"

    Index

    Variables

    BaseProjectDataProviderEngine DataProviderEngine LayeringProjectDataProviderEngineFactory ProjectDataProviderEngine diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 110dceadd5..ce65923448 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 1ef8b981e1..99ae0cf56d 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

    Papi

    Variables

    WebSocket XMLHttpRequest commands diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index 0935385c0f..49521fdaa9 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 16244ff921..c19a847be8 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

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 69bc349c39..6b2a110582 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

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

    Index

    Functions

    createWebSocket

    Settings

    Member Visibility

    Theme

    \ 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 8418f53d0d..d0fd38564c 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

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

    Index

    Type Aliases

    IWebSocket

    Settings

    Member Visibility

    Theme

    \ 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 5ba716bc98..f099a37a8f 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

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

    Index

    Type Aliases

    ExecutionActivationContext

    Settings

    Member Visibility

    Theme

    \ 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 5c30dc6df5..5b6d05dfb7 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

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

    Index

    Interfaces

    IExtension

    Settings

    Member Visibility

    Theme

    \ 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 e05b6ab687..fef5ff1981 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

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

    Index

    Type Aliases

    ExtensionManifest

    Settings

    Member Visibility

    Theme

    \ 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 6adbf65ec3..5e6b91acd0 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

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

    Index

    Namespaces

    default

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 e9415394d4..d8105b3162 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

    ExtensionStorageService

    Variables

    default

    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 60768fbaf5..68d6e2b6f2 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

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 37ce7eb209..d933285f7c 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

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

    Index

    Classes

    ExecutionToken

    Type Aliases

    ExecutionTokenType

    Settings

    Member Visibility

    Theme

    \ 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 0f241ae3e3..7e0c4341f3 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

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

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 c4199e35ce..b7c8c918ad 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

    EntryType

    Type Aliases

    DirectoryEntries

    Functions

    copyFile createDir diff --git a/papi-dts/modules/_node_utils_crypto_util_.html b/papi-dts/modules/_node_utils_crypto_util_.html index 58ba178963..b38b17964b 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,4 +1,4 @@ -"node/utils/crypto-util" | papi-dts

    Namespace "node/utils/crypto-util"

    Index

    Functions

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

    Namespace "node/utils/crypto-util"

    Index

    Functions

    createNonce createUuid generateHashFromBuffer

    Settings

    Member Visibility

    Theme

    \ 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 fdbc24640e..10db4d08e2 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

    FILE_PROTOCOL RESOURCES_PROTOCOL

    Functions

    getAppDir getPathFromUri diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index 7489f25385..aa62c85af6 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 ProjectDataProviderInterfaces 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 b3dafd4c2e..4458669904 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

    DialogDefinitionBase DialogProps

    Variables

    default

    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 bb8f452825..27a2d9cd97 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

    DialogTypes

    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 b16accb393..a699fcf5c4 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 d7a573dc99..4e73121ada 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 a10a16104b..a4f2e88724 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 8d8c5f222e..30ee425b89 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 93cfb22e75..466c4c5a65 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 1efc5c8f82..8eb3b0b635 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 898ac786df..c0a4efd57f 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

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

    Index

    Type Aliases

    UseDialogCallbackOptions

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html index 7172c005f7..74ec3b26b0 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-localized-strings-hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-localized-strings-hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-localized-strings-hook" | papi-dts

    Namespace "renderer/hooks/papi-hooks/use-localized-strings-hook"

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 4a5cc47062..6cde66166d 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 164e9a640e..63210a3846 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 d7abb488b4..358a603dc7 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 b01dfaa8e2..9737585b7a 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

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

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    \ 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 620fe1217a..c4a08d4d0e 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

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

    Index

    Classes

    default

    Functions

    blockWebSocketsToPapiNetwork

    Settings

    Member Visibility

    Theme

    \ 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 363009ce0e..d12bac1732 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

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ 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 d6559b78e7..c38c73f346 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

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

    Index

    Type Aliases

    Uri

    Settings

    Member Visibility

    Theme

    \ 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 1fec22f6e1..88b44e3c51 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

    ConnectionStatus

    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 d2f6705588..2a4fcf35a5 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

    MessageType

    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 ffa2b1fffc..76d6eeb3a5 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

    Namespace "shared/global-this.model"

    Index

    Enumerations

    ProcessType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html index 3b33f2b0bd..58fb45575b 100644 --- a/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html @@ -1,3 +1,3 @@ -"shared/models/base-project-data-provider-engine.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    BaseProjectDataProviderEngine

    Type Aliases

    IBaseProjectDataProviderEngine

    Settings

    Member Visibility

    Theme

    \ 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 75c09f0169..2ada3a6512 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

    DataProviderEngine

    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 360a7e909d..b9993f7d5e 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

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

    Index

    Type Aliases

    IDisposableDataProvider default

    Settings

    Member Visibility

    Theme

    \ 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 140bb16bb4..b5ccf74415 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 193f47701a..810feaef77 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,4 +1,4 @@ -"shared/models/dialog-options.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    DialogData DialogOptions

    Variables

    DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS

    Settings

    Member Visibility

    Theme

    \ 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 2a8bbbc4f6..176bd476d3 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

    FloatLayout PanelLayout TabLayout

    Type Aliases

    AddWebViewEvent diff --git a/papi-dts/modules/_shared_models_elevated_privileges_model_.html b/papi-dts/modules/_shared_models_elevated_privileges_model_.html index a930b5c7c7..28342dee7d 100644 --- a/papi-dts/modules/_shared_models_elevated_privileges_model_.html +++ b/papi-dts/modules/_shared_models_elevated_privileges_model_.html @@ -1,3 +1,3 @@ -"shared/models/elevated-privileges.model" | papi-dts

    Namespace "shared/models/elevated-privileges.model"

    Index

    Enumerations

    ElevatedPrivilegeNames +"shared/models/elevated-privileges.model" | papi-dts

    Namespace "shared/models/elevated-privileges.model"

    Index

    Enumerations

    ElevatedPrivilegeNames

    Type Aliases

    ElevatedPrivileges

    Settings

    Member Visibility

    Theme

    \ No newline at end of file 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 79afccf9f2..8a761ea12c 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

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

    Index

    Type Aliases

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html b/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html index 31fbe09792..2389ab3d76 100644 --- a/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html +++ b/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html @@ -1,4 +1,4 @@ -"shared/models/manage-extensions-privilege.model" | papi-dts

    Namespace "shared/models/manage-extensions-privilege.model"

    Index

    Type Aliases

    DisableExtensionFunction +"shared/models/manage-extensions-privilege.model" | papi-dts

    Namespace "shared/models/manage-extensions-privilege.model"

    Index

    Type Aliases

    DisableExtensionFunction EnableExtensionFunction ExtensionIdentifier GetInstalledExtensionsFunction diff --git a/papi-dts/modules/_shared_models_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index dae5d5b9b3..0dd148f18d 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_network_object_status_service_model_.html b/papi-dts/modules/_shared_models_network_object_status_service_model_.html index 59462ea4cb..694532664e 100644 --- a/papi-dts/modules/_shared_models_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_models_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object-status.service-model" | papi-dts

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

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType +"shared/models/network-object-status.service-model" | papi-dts

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

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType NetworkObjectStatusServiceType

    Variables

    networkObjectStatusServiceNetworkObjectName

    Settings

    Member Visibility

    Theme

    \ No newline at end of file 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 852891fec5..e6121adbea 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

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

    Index

    Classes

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html index 1969f1241a..e877fb3554 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider-engine-factory.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    LayeringProjectDataProviderEngineFactory

    Interfaces

    IProjectDataProviderEngineFactory

    Settings

    Member Visibility

    Theme

    \ 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 7d098841c4..6f9d06dcf0 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,3 +1,3 @@ -"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

    ProjectDataProviderEngine

    Type Aliases

    IProjectDataProviderEngine

    Settings

    Member Visibility

    Theme

    \ No newline at end of file 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 d1084cd8f2..889ed36168 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,4 +1,4 @@ -"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

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

    Index

    Interfaces

    default

    Type Aliases

    ProjectMetadataFilterOptions

    Variables

    PDP_FACTORY_OBJECT_TYPE

    Settings

    Member Visibility

    Theme

    \ 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 4e4be038df..8fc00840b6 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

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

    Index

    Type Aliases

    ExtensionDataScope MandatoryProjectDataTypes WithProjectDataProviderEngineExtensionDataMethods

    Variables

    PROJECT_INTERFACE_PLATFORM_BASE diff --git a/papi-dts/modules/_shared_models_project_lookup_service_model_.html b/papi-dts/modules/_shared_models_project_lookup_service_model_.html index ad46052417..5e7bfcfc29 100644 --- a/papi-dts/modules/_shared_models_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_models_project_lookup_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-lookup.service-model" | papi-dts

    Namespace "shared/models/project-lookup.service-model"

    Index

    Type Aliases

    ProjectLookupServiceType +"shared/models/project-lookup.service-model" | papi-dts

    Namespace "shared/models/project-lookup.service-model"

    Index

    Type Aliases

    ProjectLookupServiceType

    Variables

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE projectLookupServiceBase testingProjectLookupService diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index 14c0270e01..217b80eadc 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-metadata.model" | papi-dts

    Namespace "shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectDataProviderFactoryMetadataInfo +"shared/models/project-metadata.model" | papi-dts

    Namespace "shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectDataProviderFactoryMetadataInfo ProjectMetadata ProjectMetadataWithoutFactoryInfo

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index e3b1c840ec..beb537f072 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

    WebViewContentType

    Type Aliases

    GetSavedWebViewDefinition 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 6504986db4..490e7f48e4 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

    Namespace "shared/models/web-view-provider.model"

    Index

    Interfaces

    DisposableWebViewProvider IWebViewProvider WebViewProvider

    Settings

    Member Visibility

    Theme

    \ 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 909e9339d3..6915911f14 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

    moduleSummaryComments

    Functions

    createSendCommandFunction initialize registerCommand diff --git a/papi-dts/modules/_shared_services_connection_service_.html b/papi-dts/modules/_shared_services_connection_service_.html index 5630e2f490..deca2a630e 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 4e07275ae5..579b577578 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

    DataProviderService

    Variables

    default

    Functions

    getByType registerEngineByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index ac59245ffc..b69ff2f957 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

    Namespace "shared/services/dialog.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 94e71dc9a8..5e94f86ecd 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

    Namespace "shared/services/dialog.service-model"

    Index

    Interfaces

    DialogService

    Variables

    CATEGORY_DIALOG

    Settings

    Member Visibility

    Theme

    \ 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 e99a5b370d..bc9113c9c5 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

    Namespace "shared/services/internet.service"

    Index

    Interfaces

    InternetService

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_localization_service_.html b/papi-dts/modules/_shared_services_localization_service_.html index e123ce006d..e4e627df43 100644 --- a/papi-dts/modules/_shared_services_localization_service_.html +++ b/papi-dts/modules/_shared_services_localization_service_.html @@ -1,2 +1,2 @@ -"shared/services/localization.service" | papi-dts

    Namespace "shared/services/localization.service"

    Index

    Variables

    default +"shared/services/localization.service" | papi-dts

    Namespace "shared/services/localization.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_localization_service_model_.html b/papi-dts/modules/_shared_services_localization_service_model_.html index e3e50009dc..9dd599153f 100644 --- a/papi-dts/modules/_shared_services_localization_service_model_.html +++ b/papi-dts/modules/_shared_services_localization_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/localization.service-model" | papi-dts

    Namespace "shared/services/localization.service-model"

    Index

    Type Aliases

    ILocalizationService +"shared/services/localization.service-model" | papi-dts

    Namespace "shared/services/localization.service-model"

    Index

    Type Aliases

    ILocalizationService LocalizationData LocalizationDataDataTypes LocalizationSelector diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 3a7a0f9a90..9a3b783ed3 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

    Namespace "shared/services/logger.service"

    Index

    Variables

    WARN_TAG default

    Functions

    formatLog

    Settings

    Member Visibility

    Theme

    \ 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 93bdf9abd3..6a83c64938 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

    Namespace "shared/services/menu-data.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 d62eaeb274..f10bc77044 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

    IMenuDataService MenuDataDataTypes

    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 573d638cf7..6e73ef7558 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

    Namespace "shared/services/network-connector.factory"

    Index

    Functions

    createNetworkConnector

    Settings

    Member Visibility

    Theme

    \ 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 e146812fe9..3778c42564 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

    Namespace "shared/services/network-connector.interface"

    Index

    Interfaces

    default

    Settings

    Member Visibility

    Theme

    \ 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 4ba24668de..be4d48c288 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

    Interfaces

    MinimalNetworkObjectService +"shared/services/network-object.service" | papi-dts

    Namespace "shared/services/network-object.service"

    Index

    Interfaces

    MinimalNetworkObjectService NetworkObjectService

    Variables

    default minimalNetworkObjectService 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 2ecce85dfb..860ad336ab 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

    Namespace "shared/services/network-object-status.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 54fd48732a..4fbd53b557 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

    PapiNetworkService

    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 98683f165f..db85ce99a7 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

    PapiBackendProjectDataProviderService PapiFrontendProjectDataProviderService

    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 fa8f7f2aca..b8ec4ea3cd 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-lookup.service" | papi-dts

    Namespace "shared/services/project-lookup.service"

    Index

    Variables

    default +"shared/services/project-lookup.service" | papi-dts

    Namespace "shared/services/project-lookup.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 e52924d07c..c848279fe7 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

    Namespace "shared/services/project-settings.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 2aecdff612..1a53642cb1 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

    IProjectSettingsService

    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 46df2982c9..0c97a11138 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

    Namespace "shared/services/settings.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 57b04769fb..715de096dd 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 f90604e61a..bc990ae63c 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

    PapiWebViewProviderService WebViewProviderService

    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 fe77f607be..ba594089ad 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

    Namespace "shared/services/web-view.service"

    Index

    Variables

    default

    Settings

    Member Visibility

    Theme

    \ 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 d7df71a9c5..9878bceb3f 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

    Namespace "shared/services/web-view.service-model"

    Index

    Interfaces

    WebViewServiceType

    Variables

    EVENT_NAME_ON_DID_ADD_WEB_VIEW NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE

    Settings

    Member Visibility

    Theme

    \ 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 109ad9753e..fc22a86307 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 008936df19..09d31992cd 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

    RequestHandlerType

    Type Aliases

    ComplexRequest ComplexResponse ComplexResponseFailure diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 85ceeda630..26b2e555d6 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts

    Type alias Papi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility

    Theme

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

    Type alias Papi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility

    Theme

    \ 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 e071283e4d..896f063fef 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 4971ad8723..2e0597c555 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 @@ -9,4 +9,4 @@
  • executionToken: ExecutionToken

    Used to save and load data by 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 7ec4227701..e79372a356 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 @@ -23,4 +23,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.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 9b7cfd36e3..e86c6f8304 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

    Type alias ExecutionTokenType

    ExecutionTokenType: "extension"

    For now this is just for extensions, but maybe we will want to expand this in the future

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 84d3448251..d59d84b4d6 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

    Type alias DirectoryEntries

    DirectoryEntries: Readonly<{
        [entryType in EntryType]: Uri[]
    }>

    All entries in a directory, mapped from entry type to array of uris for the entries

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f0075ddd80..3d75c920e4 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';
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 a9e19fa153..fc27afdf70 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'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 79fdf30a3a..434680ae17 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>;
      }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 df7e8b3b6a..521176fccb 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html index a259f5e803..55536a7a26 100644 --- a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html @@ -19,4 +19,4 @@

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<UnsubscriberAsync>

    Settings

    Member Visibility

    Theme

    \ 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 c914bf10aa..df9a720c7d 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html @@ -10,4 +10,4 @@ IBaseProjectDataProvider, which imposes additional requirements.

    See more information, including the difference between Base and Layering PDPs, at ProjectDataProviderInterfaces.

    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 278e57b862..d319fd8249 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

    Type alias NotesOnlyProjectDataTypes

    NotesOnlyProjectDataTypes: MandatoryProjectDataTypes & {
        Notes: DataProviderDataType<string, string | undefined, string>;
    }

    This is just a simple example so we have more than one. It's not intended to be real.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 cba51a03f6..7f66c861aa 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts

    Type alias PlaceholderDataTypes

    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

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

    Type alias PlaceholderDataTypes

    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html index 60bab2f621..15a5ec9681 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html @@ -7,4 +7,4 @@ PDP.

    Example

    ProjectInterfaceDataTypes['MyExtensionProjectInterfaceName'] => MandatoryProjectDataTypes & {
        MyProjectData: DataProviderDataType<string, string, string>;
      }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html index fad75f6ce2..6e4baac81f 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html @@ -6,4 +6,4 @@ ProjectDataProviderInterfaces.

    Example

    'platform.notesOnly'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 20b8f52cb0..acc033682c 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'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 09d343953b..c3d9052ea1 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'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3c6475fd14..8c2bf287d7 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts

    Type alias StuffDataTypes

    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

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

    Type alias StuffDataTypes

    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 51426c7130..742139e155 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -25,4 +25,4 @@

    Throws

    If the setting validator failed.

    See

    DataProviderUpdateInstructions for more info on what to return

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<DataProviderUpdateInstructions<TProjectDataTypes & MandatoryProjectDataTypes>>

    Settings

    Member Visibility

    Theme

    \ 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 cffee2293d..e9fb40efba 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 @@ -14,4 +14,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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 0ba53ebef3..b88230f787 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

    Type alias DialogProps<TData>

    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
      • cancelDialog(): void

      • Cancels the dialog request (resolves the response with undefined) and closes the dialog

        -

        Returns void

    • rejectDialog:function
      • rejectDialog(errorMessage): void

      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • rejectDialog(errorMessage): void

      • 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
      • submitDialog(data): void

      • Sends the data as a resolved response to the dialog request and closes the dialog

        +

    Returns void

  • submitDialog:function
    • submitDialog(data): void

    • 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

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ 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 b96f85a795..21b60c4a19 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 7b726dd83c..df2ab27dc5 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

    Type alias DialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility

    Theme

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

    Type alias DialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 f3fd161a83..0df42efed4 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

    Type alias DialogTabTypes

    DialogTabTypes: keyof DialogTypes

    Each type of dialog. These are the tab types used in the dock layout

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ea6f04d514..c9cf74eaa8 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

    Type alias ProjectDialogOptionsBase

    ProjectDialogOptionsBase: DialogOptions & ProjectMetadataFilterOptions

    Settings

    Member Visibility

    Theme

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

    Type alias ProjectDialogOptionsBase

    ProjectDialogOptionsBase: DialogOptions & ProjectMetadataFilterOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html index 50158d53b3..735eb670fa 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html @@ -1,3 +1,3 @@ SelectBooksDialogOptions | papi-dts

    Type alias SelectBooksDialogOptions

    SelectBooksDialogOptions: DialogOptions & {
        selectedBookIds?: string[];
    }

    Options to provide when showing the Select Books dialog

    Type declaration

    • Optional selectedBookIds?: string[]

      Books IDs that should start selected in the dialog

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d8a8e7f2d3..d70bee8402 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

    Type alias SelectMultipleProjectsDialogOptions

    SelectMultipleProjectsDialogOptions: ProjectDialogOptionsBase & {
        selectedProjectIds?: string[];
    }

    Options to provide when showing the Select Multiple Project dialog

    Type declaration

    • Optional selectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 185f5c6a81..68ec3ddc29 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

    Type alias SelectProjectDialogOptions

    SelectProjectDialogOptions: ProjectDialogOptionsBase

    Options to provide when showing the Select Project dialog

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 371583d126..68d44d59b0 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

    Type alias UseDialogCallbackOptions

    UseDialogCallbackOptions: {
        maximumOpenDialogs?: number;
    }

    Type declaration

    • Optional maximumOpenDialogs?: number

      How many dialogs are allowed to be open at once from this dialog callback. Calling the callback when this number of maximum open dialogs has been reached does nothing. Set to -1 for unlimited. Defaults to 1.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 59feb565e5..5fbf2bf132 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6d84d77e60..332feff5f5 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

    Type alias ClientConnectEvent

    ClientConnectEvent: {
        clientId: number;
        didReconnect: boolean;
    }

    Event emitted when client connections are established

    -

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Settings

    Member Visibility

    Theme

    \ 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 fb18280d3c..4226cdd1a5 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

    Type alias ClientDisconnectEvent

    ClientDisconnectEvent: {
        clientId: number;
    }

    Event emitted when client connections are lost

    -

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    \ 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 8c79f73cba..d539f219f0 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

    Type alias InternalEvent<T>

    InternalEvent<T>: {
        event: T;
        senderId: number;
    }

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • event: T

      Contents of the event

    • senderId: number

      The process that emitted this Event

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 1b9ab4be7c..46bd30b2ff 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

    Type alias InternalNetworkEventHandler

    InternalNetworkEventHandler: (<T>(eventType, incomingEvent) => void)

    Handler for events from on the network. Used internally between network connector and Connection Service

    -

    Type declaration

      • <T>(eventType, incomingEvent): void

      • Type Parameters

        • T

        Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • <T>(eventType, incomingEvent): void

      • Type Parameters

        • T

        Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ 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 f205a8a376..efe535d338 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

    Type alias InternalRequest<TParam>

    InternalRequest<TParam>: {
        requestId: number;
    } & ComplexRequest<TParam>

    Request to do something and to respond

    -

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Settings

    Member Visibility

    Theme

    \ 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 21da2f9a97..87244cadc6 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

    Type alias InternalRequestHandler

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

    Handler for requests from the server. Used internally between network connector and Connection Service

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 458fd32fa2..234dcc5840 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

    Type alias InternalResponse<TReturn>

    InternalResponse<TReturn>: {
        requestId: number;
        requesterId: number;
        senderId: number;
    } & ComplexResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestId: number
    • requesterId: number

      The process that originally sent the Request that matches to this response

    • senderId: number

      The process that sent this Response

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3b6c905081..ab5c06f129 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html @@ -2,4 +2,4 @@ from NetworkEventEmitters so the events inform all interested connections

    Type declaration

    • Optional didClientConnectHandler?: ((event) => void)

      Handles when a new connection is established

    • Optional didClientDisconnectHandler?: ((event) => void)

      Handles when a client disconnects

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ad3f32c631..f001be99a2 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

    Type alias NetworkConnectorInfo

    NetworkConnectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the network connector

    -

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Settings

    Member Visibility

    Theme

    \ 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 cface8e33c..50390318b4 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

    Type alias NetworkEventHandler

    NetworkEventHandler: (<T>(eventType, event) => void)

    Handler for events from on the network

    -

    Type declaration

      • <T>(eventType, event): void

      • Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • <T>(eventType, event): void

      • Type Parameters

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    Settings

    Member Visibility

    Theme

    \ 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 671e864ba4..18a700c617 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

    Type alias RequestHandler

    RequestHandler: (<TParam, TReturn>(requestType, request) => Promise<ComplexResponse<TReturn>>)

    Handler for requests from the server

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 0e5b0ff701..1132bf741a 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

    Type alias RequestRouter

    RequestRouter: ((requestType) => number)

    Function that returns a clientId to which to send the request based on the requestType

    -

    Type declaration

      • (requestType): number

      • Parameters

        • requestType: string

        Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (requestType): number

      • Parameters

        • requestType: string

        Returns number

    Settings

    Member Visibility

    Theme

    \ 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 ee81175a95..3d6f2f373b 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

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • senderId: number
  • type: ClientConnect

    • Settings

    Member Visibility

    Theme

    \ 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 7dd5a2081c..38e5d8ffac 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

    Type alias InitClient

    InitClient: {
        clientGuid: string;
        connectorInfo: NetworkConnectorInfo;
        senderId: number;
        type: InitClient;
    }

    Message sent to the client to give it NetworkConnectorInfo

    Type declaration

    • clientGuid: string

      Guid unique to this connection. Used to verify important messages like reconnecting

      -
    • connectorInfo: NetworkConnectorInfo
    • senderId: number
    • type: InitClient

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • connectorInfo: NetworkConnectorInfo
  • senderId: number
  • type: InitClient

    • Settings

    Member Visibility

    Theme

    \ 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 049cbc4749..f5040296d6 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

    Type alias Message

    Message: InitClient | ClientConnect | WebSocketRequest | WebSocketResponse | WebSocketEvent<unknown>

    Messages send by the WebSocket

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 619a7ed04a..e02289b1aa 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

    Type alias WebSocketEvent<T>

    WebSocketEvent<T>: {
        eventType: string;
        type: Event;
    } & InternalEvent<T>

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • eventType: string

      What kind of event this is

      -
    • type: Event

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • type: Event

    • Settings

    Member Visibility

    Theme

    \ 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 971bd4d9a6..73d24b6267 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

    Type alias WebSocketRequest<TParam>

    WebSocketRequest<TParam>: {
        requestType: string;
        type: Request;
    } & InternalRequest<TParam>

    Request to do something and to respond

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Request

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • type: Request

    • Settings

    Member Visibility

    Theme

    \ 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 0c62330d41..5c4c4709f3 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

    Type alias WebSocketResponse<TReturn>

    WebSocketResponse<TReturn>: {
        requestType: string;
        type: Response;
    } & InternalResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Response

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • type: Response

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html index 0d071ba36a..6c8e804dad 100644 --- a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html @@ -27,4 +27,4 @@

    OR

    class MyPDPE implements IBaseProjectDataProviderEngine<['MyProjectData']> {
      notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
      ...
    }
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 f7692679a1..975e7dc572 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 86742e9301..9d005b03d1 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.
    • -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 2ed82ee209..cb8034e0e5 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>) {}
      ...
    }
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 f3b1134d7e..762d84d632 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

    See

    IDataProvider

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3a46c62856..14642d98ea 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 b1ce268d1f..19ef693745 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 90e47e27ee..0bc3ea688a 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>;
    }
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 258a988648..ab95fc456a 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 21b8d86fe3..b70732a774 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

    Type alias DataProviderGetters<TDataTypes>

    DataProviderGetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `get${DataType & string}`]: DataProviderGetter<TDataTypes[DataType]>
    }

    Set of all get<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderGetter for more information

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3be5dd8dd9..27c5cab2a6 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 b122f35a05..e89c8b2523 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

    Type alias DataProviderSetters<TDataTypes>

    DataProviderSetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `set${DataType & string}`]: DataProviderSetter<TDataTypes, DataType>
    }

    Set of all set<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderSetter for more information

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f5985cd8a0..743212e847 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 1fc618fcce..4a39e7abca 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'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 55e6321a34..1187ccef4c 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

    Type alias DataProviderSubscribers<TDataTypes>

    DataProviderSubscribers<TDataTypes>: {
        [DataType in keyof TDataTypes as `subscribe${DataType & string}`]: DataProviderSubscriber<TDataTypes[DataType]>
    }

    Set of all subscribe<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    See

    DataProviderSubscriber for more information

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 2f2b17b2f5..424be4a973 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ 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 462f9bc7e0..90edba3196 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

    Type alias DataTypeNames<TDataTypes>

    DataTypeNames<TDataTypes>: keyof TDataTypes & string

    Names of data types in a DataProviderDataTypes type. Indicates the data types that a data provider can handle (so it will have methods with these names like set<data_type>)

    Type Parameters

    See

    DataProviderDataTypes for more information

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 3a006b5f3f..085ad8ed7c 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 80dc099842..3c1d6ffe1f 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

    Type alias DialogData

    DialogData: DialogOptions & {
        isDialog: true;
    }

    Data in each tab that is a dialog. Added to DialogOptions in dialog.service-host.ts

    -

    Type declaration

    • isDialog: true

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • isDialog: true

    Settings

    Member Visibility

    Theme

    \ 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 cf59a6436b..a55cdca4bb 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -6,4 +6,4 @@
  • Optional title?: string | LocalizeKey

    Dialog title to display in the header. If you provide a LocalizeKey, it will be localized before displaying.

    Default depends on the dialog

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6fa29ed7a0..74ca3e09af 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

    Type alias AddWebViewEvent

    AddWebViewEvent: {
        layout: Layout;
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are created

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 447b9b80bc..03a904da96 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
    • -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 29e5f3eb82..ee8402b9f8 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

    Type alias FloatSize

    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -

    Type declaration

    • height: number
    • width: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • height: number
    • width: number

    Settings

    Member Visibility

    Theme

    \ 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 dc51afe25e..d31d7187ec 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

    Type alias Layout

    Layout: TabLayout | FloatLayout | PanelLayout

    Information about how a Paranext tab fits into the dock layout

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 e269a1ab6e..f6d9440bfa 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

    Type alias OnLayoutChangeRCDock

    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>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (newLayout, currentTabId?, direction?): Promise<void>

      • Parameters

        • newLayout: LayoutBase
        • Optional currentTabId: string
        • Optional direction: DropDirection

        Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ 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 2a53398b7a..b58bc17415 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

    Type alias PanelDirection

    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Settings

    Member Visibility

    Theme

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

    Type alias PanelDirection

    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Settings

    Member Visibility

    Theme

    \ 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 2ca2e1ce4a..7b5a157bb8 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -27,4 +27,4 @@
      • (webViewId, updateInfo): boolean

      • Parameters

        • webViewId: string

          The ID of the WebView to update

        • updateInfo: WebViewDefinitionUpdateInfo

          Properties to update on the WebView. Any unspecified properties will stay the same

          -

        Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ 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 af5811313f..d8a3684249 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 2bd3bc03d6..da45adab76 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 08141b52c8..3c5090836b 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

    Type alias TabLoader

    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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 b701d4661a..7248584404 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 97ec491b11..816f01b280 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

    Type alias WebViewTabProps

    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html b/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html index bbf1e88a64..39c04115ca 100644 --- a/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html +++ b/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html @@ -1,3 +1,3 @@ ElevatedPrivileges | papi-dts

    Type alias ElevatedPrivileges

    ElevatedPrivileges: {
        manageExtensions: ManageExtensions | undefined;
    }

    Object that contains properties with special capabilities for extensions that required them

    Type declaration

    • manageExtensions: ManageExtensions | undefined

      Functions that can be run to manage what extensions are running

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 94f841dc6c..781317a3ba 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html index d314e4d4e6..4bf064aae2 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html @@ -1,4 +1,4 @@ DisableExtensionFunction | papi-dts

    Type alias DisableExtensionFunction

    DisableExtensionFunction: ((extensionIdentifier) => Promise<void>)

    Stop running an extension that had been previously downloaded and enabled

    Type declaration

      • (extensionIdentifier): Promise<void>

      • Parameters

        Returns Promise<void>

    Returns

    Promise that resolves when the extension has been enabled, throws if enabling fails

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html index 4324089dcd..3e4b9c114c 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html @@ -1,4 +1,4 @@ EnableExtensionFunction | papi-dts

    Type alias EnableExtensionFunction

    EnableExtensionFunction: ((extensionIdentifier) => Promise<void>)

    Start running an extension that had been previously downloaded and disabled

    Type declaration

      • (extensionIdentifier): Promise<void>

      • Parameters

        Returns Promise<void>

    Returns

    Promise that resolves when the extension has been enabled, throws if enabling fails

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html index 62e9f114ca..4cc5507be6 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html @@ -1,2 +1,2 @@ ExtensionIdentifier | papi-dts

    Type alias ExtensionIdentifier

    ExtensionIdentifier: {
        extensionName: string;
        extensionVersion: string;
    }

    Represents an extension that can be enabled or disabled

    -

    Type declaration

    • extensionName: string
    • extensionVersion: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html index 6db7f75762..4cbf2e806c 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html @@ -1,2 +1,2 @@ GetInstalledExtensionsFunction | papi-dts

    Type alias GetInstalledExtensionsFunction

    GetInstalledExtensionsFunction: (() => Promise<InstalledExtensions>)

    Get extension identifiers of all extensions on the system

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html index b21757f2a2..3d52707162 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html @@ -1,2 +1,2 @@ HashValues | papi-dts

    Type alias HashValues

    HashValues: Partial<{
        sha256: string;
        sha512: string;
    }>

    Base64 encoded hash values

    -

    Type declaration

    • sha256: string
    • sha512: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html index 1abc98058c..2cede73bfa 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html @@ -6,4 +6,4 @@ validation. For example, if you provide a sha256 hash value and a sha512 hash value, the installer may only use the sha512 hash value for validation.

    Returns Promise<void>

    Returns

    Promise that resolves when the extension has been installed

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html index 99f47ec5b3..9c7f90ddae 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html @@ -8,4 +8,4 @@ or removed from the set of enabled extensions.

  • packaged: ExtensionIdentifier[]

    Extensions that are explicitly bundled to be part of the application. They cannot be disabled. At runtime no extensions can be added or removed from the set of packaged extensions.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html index e537727eaf..d0687583f0 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html @@ -3,4 +3,4 @@
  • enableExtension: EnableExtensionFunction

    Function to start running an extension that had been previously downloaded and disabled

  • getInstalledExtensions: GetInstalledExtensionsFunction

    Function to retrieve details about all installed extensions

  • installExtension: InstallExtensionFunction

    Function to download an extension and enable it

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 d3c70e8491..9b1ff7223d 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

    Type alias DisposableNetworkObject<T>

    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

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

    Type Parameters

    See

    networkObjectService

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 02ad183626..0cf3739cf9 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 fdc46eff30..534bf5a378 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 5e08c57b9b..61a262c756 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6119435bc0..3371f223bb 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

    Type alias NetworkableObject<T>

    NetworkableObject<T>: T & CannotHaveOnDidDispose

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

    Type Parameters

    • T = object

    See

    networkObjectService

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 be0a1fa09c..635665d5f0 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 @@ -26,4 +26,4 @@

    OR

    class MyPDPE implements IProjectDataProviderEngine<['MyProjectData']> {
      notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
      ...
    }
    -

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html index 44e81fde30..5c4d37e751 100644 --- a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html @@ -1,3 +1,3 @@ ProjectMetadataFilterOptions | papi-dts

    Type alias ProjectMetadataFilterOptions

    ProjectMetadataFilterOptions: ModifierProject & {
        excludeProjectIds?: string | string[];
        includeProjectIds?: string | string[];
    }

    Type declaration

    • Optional excludeProjectIds?: string | string[]

      Project IDs to exclude

    • Optional includeProjectIds?: string | string[]

      Project IDs to include

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6f1562fd60..baa85dfd64 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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 71a336c85a..83358144b2 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 @@ -49,4 +49,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    SettingExtensionData
    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    SettingExtensionData
    \ 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 1cb4e9e8b8..f6a6bece2e 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

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html index c7af7e7116..a3ba7ab52c 100644 --- a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html @@ -8,8 +8,8 @@ https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator:

    Only strings that differ in base letters or accents and other diacritic marks compare as unequal. Examples: a ≠ b, a ≠ á, a = A.

    -

    Parameters

    Returns boolean

  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function
  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function

    Returns Promise<ProjectMetadata[]>

    ProjectMetadata for all projects stored on the local system

    -
  • getMetadataForProject:function
  • getMetadataForProject:function

    Returns Promise<ProjectMetadata>

    ProjectMetadata for the given project

    -
  • getMinimalMatchPdpFactoryId:function
  • getMinimalMatchPdpFactoryId:function

    Returns undefined | string

    PDP Factory id whose projectInterfaces minimally match the provided projectInterface if at least one PDP Factory was found that supports the projectInterface provided

    -
  • mergeMetadataFilters:function

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • mergeMetadataFilters:function

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html index bc66b85ced..2a47745c0b 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html @@ -1,4 +1,4 @@ ProjectDataProviderFactoryMetadataInfo | papi-dts

    Type alias ProjectDataProviderFactoryMetadataInfo

    ProjectDataProviderFactoryMetadataInfo: {
        projectInterfaces: ProjectInterfaces[];
    }

    Type declaration

    • projectInterfaces: ProjectInterfaces[]

      Which projectInterfaces (aka standardized sets of methods on a PDP) the Project Data Provider for this project created by this Project Data Provider Factory supports. Indicates what sort of project data should be available on this project from this PDP Factory.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 4ec868fd87..b21017bfd6 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -12,4 +12,4 @@

    The keys of this object are ids of the PDP Factories that provide the metadata, namely the projectInterfaces for this project (meaning this PDPF can provide a Project Data Provider for this project with these projectInterfaces)

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html index fa68c77ab3..27b8f1cff9 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html @@ -6,4 +6,4 @@
  • projectInterfaces: ProjectInterfaces[]

    All projectInterfaces (aka standardized sets of methods on a PDP) that Project Data Providers for this project support. Indicates what sort of project data should be available on this project.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html index 6d9d4bfa83..5c1b6be764 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html @@ -1,4 +1,4 @@ GetSavedWebViewDefinition | papi-dts

    Type alias GetSavedWebViewDefinition

    GetSavedWebViewDefinition: (() => SavedWebViewDefinition | undefined)

    Gets the saved properties on this WebView's WebView definition

    ＠returns saved properties this WebView's WebView definition or undefined if not found for some reason

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 42fe6d72b0..24abb1c96d 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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 34349e6c09..55ed5d3f01 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

    Type alias SavedWebViewDefinition

    SavedWebViewDefinition: (Partial<Omit<WebViewDefinitionReact, SavedWebViewDefinitionOmittedKeys>> | Partial<Omit<WebViewDefinitionHtml, SavedWebViewDefinitionOmittedKeys>> | Partial<Omit<WebViewDefinitionURL, SavedWebViewDefinitionOmittedKeys>>) & 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.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html index 238e27b3c9..b2af65b0be 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html @@ -1,3 +1,3 @@ SavedWebViewDefinitionOmittedKeys | papi-dts

    Type alias SavedWebViewDefinitionOmittedKeys

    SavedWebViewDefinitionOmittedKeys: typeof SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS[number]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 f219669d7e..a04b81c8f4 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -6,4 +6,4 @@

    ＠example

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 2be06769a9..9c44739149 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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ 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 1a5047b4fa..f2c520da28 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

    Type alias WebViewDefinition

    WebViewDefinition: WebViewDefinitionReact | WebViewDefinitionHtml | WebViewDefinitionURL

    Properties defining a type of WebView created by extensions to show web content

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 1b88a2fdf4..4c31fe8d65 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -70,4 +70,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

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 ec2a86d152..6e1c2751f7 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

    Type alias WebViewDefinitionHtml

    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 74f2ab0626..2c07ed90fe 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

    Type alias WebViewDefinitionReact

    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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 84f30ed4fd..1e92dd777d 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

    Type alias WebViewDefinitionURL

    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

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 52cb28a341..2dfbdf4104 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

    Type alias WebViewDefinitionUpdatableProperties

    WebViewDefinitionUpdatableProperties: Pick<WebViewDefinitionBase, typeof WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS[number]>

    The properties on a WebViewDefinition that may be updated when that webview is already displayed

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 fce1064194..81a903d24a 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

    Type alias WebViewDefinitionUpdateInfo

    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 0ad7a3e8c8..d14dbb7935 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

    Type alias WebViewId

    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 7738fe723b..2ff9315611 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -33,4 +33,4 @@

    ＠example

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 98b9f6f0f3..1ef3573afd 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

    Type alias WebViewType

    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 6ca1597214..00997f7acd 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

    Type alias moduleSummaryComments

    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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html index 37438d2cf6..5f8809407b 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html +++ b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html @@ -9,8 +9,8 @@ string key that corresponds to a localized value and an array of BCP 47 language codes

      Returns Promise<LocalizationData>

    • setLocalizedString:function
    • setLocalizedStrings:function
    • setLocalizedStrings:function

      • Type declaration

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<string>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html index e233bff50d..43799ce94b 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html @@ -1 +1 @@ -LocalizationData | papi-dts

      Type alias LocalizationData

      LocalizationData: LanguageStrings

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationData

      LocalizationData: LanguageStrings

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html index fd5026f1e8..0bec257c04 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html @@ -1 +1 @@ -LocalizationDataDataTypes | papi-dts

      Type alias LocalizationDataDataTypes

      LocalizationDataDataTypes: {
          LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
          LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationDataDataTypes

      LocalizationDataDataTypes: {
          LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
          LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html index 77b376906f..8657c553db 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html @@ -1 +1 @@ -LocalizationSelector | papi-dts

      Type alias LocalizationSelector

      LocalizationSelector: {
          locales?: string[];
          localizeKey: LocalizeKey;
      }

      Type declaration

      • Optional locales?: string[]
      • localizeKey: LocalizeKey

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationSelector

      LocalizationSelector: {
          locales?: string[];
          localizeKey: LocalizeKey;
      }

      Type declaration

      • Optional locales?: string[]
      • localizeKey: LocalizeKey

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html index 47693e36f4..daf32de272 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html @@ -1 +1 @@ -LocalizationSelectors | papi-dts

      Type alias LocalizationSelectors

      LocalizationSelectors: {
          locales?: string[];
          localizeKeys: LocalizeKey[];
      }

      Type declaration

      • Optional locales?: string[]
      • localizeKeys: LocalizeKey[]

      Settings

      Member Visibility

      Theme

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

      Type alias LocalizationSelectors

      LocalizationSelectors: {
          locales?: string[];
          localizeKeys: LocalizeKey[];
      }

      Type declaration

      • Optional locales?: string[]
      • localizeKeys: LocalizeKey[]

      Settings

      Member Visibility

      Theme

      \ 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 033ab634c5..be54fc8990 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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 6656904423..6a8a1ca6b7 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

      Type alias MenuDataDataTypes

      MenuDataDataTypes: {
          MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
          WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

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

      Type alias MenuDataDataTypes

      MenuDataDataTypes: {
          MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
          WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 84b59a853a..27e3006c19 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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 4cd54e320f..b24e5553c1 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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 cdb47a2d5a..6fddd7ae59 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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 86a38c253d..724604f634 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

      Type alias AllProjectSettingsValidators

      AllProjectSettingsValidators: {
          [ProjectSettingName in ProjectSettingNames]: ProjectSettingValidator<ProjectSettingName>
      }

      Validators for all project settings. Keys are setting keys, values are functions to validate new settings

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 6c6632441b..81dca9e3cd 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 @@ -2,4 +2,4 @@

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Returns Promise<boolean>

      Settings

      Member Visibility

      Theme

      \ 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 05f448daa1..5f501c84d1 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

      Type alias SimultaneousProjectSettingsChanges

      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

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 0738b9c67e..bb6fc79669 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

      Type alias AllSettingsData

      AllSettingsData: {
          [SettingName in SettingNames]: SettingTypes[SettingName]
      }

      Settings

      Member Visibility

      Theme

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

      Type alias AllSettingsData

      AllSettingsData: {
          [SettingName in SettingNames]: SettingTypes[SettingName]
      }

      Settings

      Member Visibility

      Theme

      \ 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 b877c2a502..624d3d706a 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

      Type alias AllSettingsValidators

      AllSettingsValidators: {
          [SettingName in SettingNames]: SettingValidator<SettingName>
      }

      Validators for all settings. Keys are setting keys, values are functions to validate new settings

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 2fbe0a5c11..12dc46840b 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

      • Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 ec86087b6e..9f5a2c9466 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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 3d66b0e059..70ceb58897 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

      Type alias SettingValidator<SettingName>

      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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 064efdf0df..c3e9e71370 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

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 bbd2e9c0b3..68bcbd928b 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>

      ComplexResponse<TReturn>: ComplexResponseSuccess<TReturn> | ComplexResponseFailure

      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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type Parameters

      Settings

      Member Visibility

      Theme

      \ 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 87efa07b5c..8f98d3aebb 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

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 580a949fac..756548aa09 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

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 eb403d88ad..5c362c66ed 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

      Type alias RequestType

      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

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 d7cd8225ac..da703e5a30 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

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html index 5a71caac32..1db78d6a23 100644 --- a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html @@ -6,4 +6,4 @@ 
      this.notifyUpdate('Setting');

      See

      IBaseProjectDataProviderEngine for more information on extending this class.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 64f9fb70bb..a793943851 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.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html index 7c8c3f3c02..98c08eb1b0 100644 --- a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html @@ -5,4 +5,4 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 8c20907cdd..dd98102a7d 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -6,4 +6,4 @@ 
      this.notifyUpdate('Setting');

      See

      IProjectDataProviderEngine for more information on extending this class.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 9361ee0a22..060e45e04c 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

      commands: typeof "shared/services/command.service"

      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.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 d1952e68e9..df591c1951 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

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 760b31aae2..d8fb0747e3 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -70,4 +70,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.

      -

      • Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 e319a73408..d64ef1aaab 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

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 6aa75aa833..a9a7837c21 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

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.localization.html b/papi-dts/variables/__papi_backend_.localization.html index e972784e64..722266be73 100644 --- a/papi-dts/variables/__papi_backend_.localization.html +++ b/papi-dts/variables/__papi_backend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

      Variable localizationConst

      localization: ILocalizationService

      Service that allows to get and store localizations

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 544119ea87..0bbd8f5873 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

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Type declaration

      Settings

      Member Visibility

      Theme

      \ 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 316a07b3e6..3df633178a 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

      menuData: IMenuDataService

      Service that allows to get and store menu data

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 630d4ab960..b73812ddf6 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

      network: PapiNetworkService

      Service that provides a way to send and receive network events

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.networkObjectStatus.html b/papi-dts/variables/__papi_backend_.networkObjectStatus.html index 57a1e17c4d..fe7a1f8836 100644 --- a/papi-dts/variables/__papi_backend_.networkObjectStatus.html +++ b/papi-dts/variables/__papi_backend_.networkObjectStatus.html @@ -1,2 +1,2 @@ networkObjectStatus | papi-dts

      Variable networkObjectStatusConst

      networkObjectStatus: NetworkObjectStatusServiceType

      Provides functions related to the set of available network objects

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.networkObjects.html b/papi-dts/variables/__papi_backend_.networkObjects.html index 70a7f814e5..ddf033fc4e 100644 --- a/papi-dts/variables/__papi_backend_.networkObjects.html +++ b/papi-dts/variables/__papi_backend_.networkObjects.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.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 07cbcbacfd..72d0ebcb6a 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

      projectDataProviders: PapiBackendProjectDataProviderService

      Service that registers and gets project data providers

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 6c436459b6..75847cc666 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -2,4 +2,4 @@

      Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 e329a10d89..6cd29fc534 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,2 +1,2 @@ projectSettings | papi-dts

      Variable projectSettingsConst

      projectSettings: IProjectSettingsService

      Provides utility functions that project data providers should call when handling project settings

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.settings.html b/papi-dts/variables/__papi_backend_.settings.html index 3a8c72cc24..d016ffcd53 100644 --- a/papi-dts/variables/__papi_backend_.settings.html +++ b/papi-dts/variables/__papi_backend_.settings.html @@ -1 +1 @@ -settings | papi-dts

      Variable settingsConst

      settings: ISettingsService

      Settings

      Member Visibility

      Theme

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

      Variable settingsConst

      settings: ISettingsService

      Settings

      Member Visibility

      Theme

      \ 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 de208db0cf..89e83580d4 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

      storage: ExtensionStorageService

      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.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 9f23cd5ac5..aba8162bf3 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

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 441cc85f31..9b74f1b569 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

      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.

      -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      \ 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 be2005bec2..cd5cb81542 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 0f87bccd88..8220e9b521 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 ebd3815c07..e13c2645bb 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 06973f6d35..98d87795b0 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

        commands: typeof "shared/services/command.service"

        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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 c95d378b13..f3bc2d4db9 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 8fdddd4d68..49fd1d96d3 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -26,4 +26,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.

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 322c1cbee2..526eaab74f 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 8e32e15d70..73eec1aac5 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.localization.html b/papi-dts/variables/__papi_frontend_.localization.html index 0d4eca0443..fac98c61bc 100644 --- a/papi-dts/variables/__papi_frontend_.localization.html +++ b/papi-dts/variables/__papi_frontend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

        Variable localizationConst

        localization: ILocalizationService

        Service that allows to get and store localizations

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 f804f43ae6..434f7f44f9 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 9f286b2cb7..e04eae4db8 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

        menuData: IMenuDataService

        Service that allows to get and store menu data

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 f04f588b79..7421c059fe 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

        network: PapiNetworkService

        Service that provides a way to send and receive network events

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 fa1d6a74eb..d1d55db158 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

        projectDataProviders: PapiFrontendProjectDataProviderService

        Service that registers and gets project data providers

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 7377f2ca02..4c14e583cb 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -2,4 +2,4 @@

        Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 9fde472b1a..20eaa269aa 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: typeof "@papi/frontend/react"

        React hooks that enable interacting with the papi in React components more easily.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 c338d6f97b..82893c545c 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts

        Variable settingsConst

        settings: ISettingsService

        Settings

        Member Visibility

        Theme

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

        Variable settingsConst

        settings: ISettingsService

        Settings

        Member Visibility

        Theme

        \ 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 db650fa312..032b44a87d 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

        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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 307c2e5cb9..15e238a0cc 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

        Variable defaultConst

        default: ExtensionStorageService

        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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 2a32f492fc..fc160ede70 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

        Variable defaultConst

        default: {
            registerExtension: typeof registerExtension;
            tokenIsValid: typeof tokenIsValid;
            unregisterExtension: typeof unregisterExtension;
        }

        Type declaration

        • registerExtension: typeof registerExtension
        • tokenIsValid: typeof tokenIsValid
        • unregisterExtension: typeof unregisterExtension

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: {
            registerExtension: typeof registerExtension;
            tokenIsValid: typeof tokenIsValid;
            unregisterExtension: typeof unregisterExtension;
        }

        Type declaration

        • registerExtension: typeof registerExtension
        • tokenIsValid: typeof tokenIsValid
        • unregisterExtension: typeof unregisterExtension

        Settings

        Member Visibility

        Theme

        \ 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 76a0308f80..9775fd7372 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://'

        Settings

        Member Visibility

        Theme

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

        Variable FILE_PROTOCOLConst

        FILE_PROTOCOL: "file://" = 'file://'

        Settings

        Member Visibility

        Theme

        \ 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 f763516013..3ab431902c 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://'

        Settings

        Member Visibility

        Theme

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

        Variable RESOURCES_PROTOCOLConst

        RESOURCES_PROTOCOL: "resources://" = 'resources://'

        Settings

        Member Visibility

        Theme

        \ 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 fe56cb5f05..97fdd0b2c2 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 }

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html index dcf312de6a..79d9332f16 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_BOOKS_DIALOG_TYPE | papi-dts

        Variable SELECT_BOOKS_DIALOG_TYPEConst

        SELECT_BOOKS_DIALOG_TYPE: "platform.selectBooks" = 'platform.selectBooks'

        The tabType for the select books dialog in select-books.dialog.tsx

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 7b2ef7d4ad..e95b538cd6 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

        Variable SELECT_MULTIPLE_PROJECTS_DIALOG_TYPEConst

        SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE: "platform.selectMultipleProjects" = 'platform.selectMultipleProjects'

        The tabType for the select multiple projects dialog in select-multiple-projects.dialog.tsx

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 65e9d2108f..9ad34aa72e 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

        Variable SELECT_PROJECT_DIALOG_TYPEConst

        SELECT_PROJECT_DIALOG_TYPE: "platform.selectProject" = 'platform.selectProject'

        The tabType for the select project dialog in select-project.dialog.tsx

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 1533d0dc28..91fb0c226f 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

        Variable CATEGORY_COMMANDConst

        CATEGORY_COMMAND: "command" = 'command'

        Prefix on requests that indicates that the request is a command

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 80ac2d9669..a732d92fd3 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

        Variable CLIENT_ID_SERVERConst

        CLIENT_ID_SERVER: 0 = 0

        "Client id" for the server

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 e743062177..4c414cbb98 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

        Variable CLIENT_ID_UNASSIGNEDConst

        CLIENT_ID_UNASSIGNED: -1 = -1

        Represents when the client id has not been assigned by the server

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html index d76f160cf6..8f6e4cd45a 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html @@ -1,4 +1,4 @@ CLIENT_ID_UNKNOWN | papi-dts

        Variable CLIENT_ID_UNKNOWNConst

        CLIENT_ID_UNKNOWN: -2 = -2

        Represents when the request router does not know to which client id the request belongs. Server should try to determine the correct client id through other means, and client should just send to server

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 c2f8c1f8ed..0dde9f14a0 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

        Variable CONNECTOR_INFO_DISCONNECTEDConst

        CONNECTOR_INFO_DISCONNECTED: Readonly<{
            clientId: -1;
        }>

        Represents when the connector info has not been populated by the server

        -

        Type declaration

        • clientId: -1

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 7a4f9af206..2e7ad113cd 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

        Variable WEBSOCKET_ATTEMPTS_MAXConst

        WEBSOCKET_ATTEMPTS_MAX: 5 = 5

        Number of attempts a client will make to connect to the WebSocket server before failing

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 916babaf6b..d1bd1bc2d9 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

        Variable WEBSOCKET_ATTEMPTS_WAITConst

        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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 05ee39f0b4..52f517a118 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

        Variable WEBSOCKET_PORTConst

        WEBSOCKET_PORT: 8876 = 8876

        Port to use for the webSocket

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html index d56ce282a8..f24b18baa4 100644 --- a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html @@ -1,2 +1,2 @@ DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS | papi-dts

        Variable DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYSConst

        DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS: readonly ["title", "prompt"]

        Keys of properties on DialogOptions that should be localized if they are LocalizeKeys

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index 2db0227e02..0dfd89acf4 100644 --- a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts

        Variable networkObjectStatusServiceNetworkObjectNameConst

        networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

        Settings

        Member Visibility

        Theme

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

        Variable networkObjectStatusServiceNetworkObjectNameConst

        networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html index e1fc4e25fc..9f2936ef52 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html @@ -1 +1 @@ -PDP_FACTORY_OBJECT_TYPE | papi-dts

        Variable PDP_FACTORY_OBJECT_TYPEConst

        PDP_FACTORY_OBJECT_TYPE: string

        Settings

        Member Visibility

        Theme

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

        Variable PDP_FACTORY_OBJECT_TYPEConst

        PDP_FACTORY_OBJECT_TYPE: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html index 18ff12451b..328fc05cdf 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html @@ -1,3 +1,3 @@ PROJECT_INTERFACE_PLATFORM_BASE | papi-dts

        Variable PROJECT_INTERFACE_PLATFORM_BASEConst

        PROJECT_INTERFACE_PLATFORM_BASE: "platform.base" = 'platform.base'

        The name of the projectInterface representing the essential methods every Base Project Data Provider must implement

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html index f9dad4cb2b..931e9e415a 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts

        Variable NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICEConst

        NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'

        Settings

        Member Visibility

        Theme

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

        Variable NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICEConst

        NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html index fc8ca16973..8b87bb6546 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html @@ -1,2 +1,2 @@ projectLookupServiceBase | papi-dts

        Variable projectLookupServiceBaseConst

        projectLookupServiceBase: ProjectLookupServiceType

        Local object of functions to run locally on each process as part of the project lookup service

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html index 6b632b6fbc..51162aa951 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html @@ -1,2 +1,2 @@ testingProjectLookupService | papi-dts

        Variable testingProjectLookupServiceConst

        testingProjectLookupService: {
            compareProjectDataProviderFactoryMetadataInfoMinimalMatch: typeof compareProjectDataProviderFactoryMetadataInfoMinimalMatch;
            internalGetMetadata: typeof internalGetMetadata;
            transformGetMetadataForProjectParametersToFilter: typeof transformGetMetadataForProjectParametersToFilter;
        }

        This is an internal-only export for testing purposes and should not be used in development

        -

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html index e7e858ae7f..3cbf739e65 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html @@ -1,3 +1,3 @@ SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS | papi-dts

        Variable SAVED_WEBVIEW_DEFINITION_OMITTED_KEYSConst

        SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS: readonly ["content", "styles", "allowScripts", "allowSameOrigin", "allowedFrameSources"]

        The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html index 15a5b44d38..a6295b18aa 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html @@ -1,3 +1,3 @@ WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS | papi-dts

        Variable WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYSConst

        WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS: readonly ["iconUrl", "title", "tooltip", "projectId"]

        The keys of properties on a WebViewDefinition that may be updated when that webview is already displayed

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 64291e9239..73ce9c3806 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

        Variable defaultConst

        default: DataProviderService

        Service that allows extensions to send and receive data to/from other extensions

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 3a89a45357..92d475a74c 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

        Variable defaultConst

        default: DialogService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: DialogService

        Settings

        Member Visibility

        Theme

        \ 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 1da5a52bdb..210f9f061e 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

        Variable CATEGORY_DIALOGConst

        CATEGORY_DIALOG: "dialog" = 'dialog'

        Prefix on requests that indicates that the request is related to dialog operations

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 555c0fb513..f54bb419dd 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

        Variable defaultConst

        default: InternetService

        Service that provides a way to call fetch since the original function is not available

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_.default.html b/papi-dts/variables/_shared_services_localization_service_.default.html index 083a2136c1..0e440c6928 100644 --- a/papi-dts/variables/_shared_services_localization_service_.default.html +++ b/papi-dts/variables/_shared_services_localization_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Variable defaultConst

        default: ILocalizationService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: ILocalizationService

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html index 8f2141e52d..fb432e4670 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html @@ -1,3 +1,3 @@ localizationServiceObjectToProxy | papi-dts

        Variable localizationServiceObjectToProxyConst

        localizationServiceObjectToProxy: Readonly<{
            dataProviderName: "platform.localizationDataServiceDataProvider";
        }>

        Type declaration

        • dataProviderName: "platform.localizationDataServiceDataProvider"

          This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html index d3f90c6ba6..dfa263d0c9 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html @@ -1,3 +1,3 @@ localizationServiceProviderName | papi-dts

        Variable localizationServiceProviderNameConst

        localizationServiceProviderName: "platform.localizationDataServiceDataProvider" = 'platform.localizationDataServiceDataProvider'

        This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 26600812b3..2d8fb5e861 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

        Variable WARN_TAGConst

        WARN_TAG: "<WARN>" = '<WARN>'

        Settings

        Member Visibility

        Theme

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

        Variable WARN_TAGConst

        WARN_TAG: "<WARN>" = '<WARN>'

        Settings

        Member Visibility

        Theme

        \ 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 fe859744c5..d65c6265bd 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

        Variable defaultConst

        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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 0a5bb0423d..1bb5ecbc8d 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

        Variable defaultConst

        default: IMenuDataService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: IMenuDataService

        Settings

        Member Visibility

        Theme

        \ 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 4e1a477edd..a954393f84 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

        Variable menuDataServiceObjectToProxyConst

        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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 0f7ba710ea..d9f9038ded 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

        Variable menuDataServiceProviderNameConst

        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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 efd6ffcea4..bfe049e6ee 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html b/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html index 355f09493a..3d73c096a9 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html +++ b/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 b632973b30..06e6c17f88 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,2 +1,2 @@ default | papi-dts

        Variable defaultConst

        default: NetworkObjectStatusServiceType

        Provides functions related to the set of available network objects

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 a7b93c8ef3..f6e80d6e44 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

        Variable papiNetworkServiceConst

        papiNetworkService: PapiNetworkService

        Service that provides a way to send and receive network events

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 2fa873ee60..ab34c948c7 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

        Variable papiBackendProjectDataProviderServiceConst

        papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

        Service that registers and gets project data providers

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 2d90c21275..71cba8baaa 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

        Variable papiFrontendProjectDataProviderServiceConst

        papiFrontendProjectDataProviderService: {
            get: typeof get;
        }

        Service that gets project data providers

        -

        Type declaration

        • get: typeof get

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 8a85de6294..c2cbf9fb75 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

        Variable defaultConst

        default: "shared/models/project-lookup.service-model"

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: "shared/models/project-lookup.service-model"

        Settings

        Member Visibility

        Theme

        \ 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 6366fe3d7f..0a37c6a1e3 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

        Variable defaultConst

        default: IProjectSettingsService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: IProjectSettingsService

        Settings

        Member Visibility

        Theme

        \ 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 872a144c87..0aa2fbd553 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

        Variable CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATORConst

        CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR: "extensionProjectSettingValidator" = 'extensionProjectSettingValidator'

        Name prefix for registered commands that call project settings validators

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 0b4f979aa2..a455dab9c7 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

        Variable projectSettingsServiceNetworkObjectNameConst

        projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

        Settings

        Member Visibility

        Theme

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

        Variable projectSettingsServiceNetworkObjectNameConst

        projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

        Settings

        Member Visibility

        Theme

        \ 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 3b91dfe100..e2455354c9 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 @@ -2,4 +2,4 @@

        Returns

        Unsubscriber that should be called whenever the providing extension is deactivated

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns Promise<UnsubscriberAsync>

        Settings

        Member Visibility

        Theme

        \ 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 ce004aefa9..bb307683ba 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

        Variable defaultConst

        default: ISettingsService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: ISettingsService

        Settings

        Member Visibility

        Theme

        \ 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 bd8aa6320c..8ed40ee49b 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

        Variable CATEGORY_EXTENSION_SETTING_VALIDATORConst

        CATEGORY_EXTENSION_SETTING_VALIDATOR: "extensionSettingValidator" = 'extensionSettingValidator'

        Name prefix for registered commands that call settings validators

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 580b1eeffe..36e04791a3 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

        Variable settingsServiceDataProviderNameConst

        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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 13901eb547..af39665107 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html @@ -4,4 +4,4 @@

        Returns

        Unsubscriber that should be called whenever the providing extension is deactivated

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns Promise<UnsubscriberAsync>

        Settings

        Member Visibility

        Theme

        \ 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 578b13dfb0..8497b64a94 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

        Variable defaultConst

        default: WebViewProviderService

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: WebViewProviderService

        Settings

        Member Visibility

        Theme

        \ 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 0110c39d5a..45654fa2f2 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

        Variable papiWebViewProviderServiceConst

        papiWebViewProviderService: PapiWebViewProviderService

        Interface for registering webView providers

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 1dad635252..a9220cd7f9 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

        Variable defaultConst

        default: WebViewServiceType

        Settings

        Member Visibility

        Theme

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

        Variable defaultConst

        default: WebViewServiceType

        Settings

        Member Visibility

        Theme

        \ 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 fce47c623c..d11c1c247c 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

        Variable EVENT_NAME_ON_DID_ADD_WEB_VIEWConst

        EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

        Name to use when creating a network event that is fired when webViews are created

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 1850634d60..852243b45b 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

        Variable NETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

        NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

        Settings

        Member Visibility

        Theme

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

        Variable NETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

        NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

        Settings

        Member Visibility

        Theme

        \ 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 7d07dc0fbc..2ca2a8cbbd 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ 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 ad6421c6ba..299003f82d 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/isNoisyDevModeEnabled.html b/papi-dts/variables/isNoisyDevModeEnabled.html index 57599eb0b0..350432b991 100644 --- a/papi-dts/variables/isNoisyDevModeEnabled.html +++ b/papi-dts/variables/isNoisyDevModeEnabled.html @@ -1,2 +1,2 @@ isNoisyDevModeEnabled | papi-dts

        Variable isNoisyDevModeEnabled

        isNoisyDevModeEnabled: boolean

        Indicates whether test code meant just for developers to see should be run

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 72cfe6247b..d85f47666c 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index da0c4b8949..691118d187 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 6fc5bab75c..5f6c1f399c 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index b73872b599..19f41a6e9c 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/enums/DropdownMenuItemType.html b/platform-bible-react/enums/DropdownMenuItemType.html index 0502a8be83..c936834fe3 100644 --- a/platform-bible-react/enums/DropdownMenuItemType.html +++ b/platform-bible-react/enums/DropdownMenuItemType.html @@ -1,3 +1,3 @@ -DropdownMenuItemType | platform-bible-react

        Enumeration DropdownMenuItemType

        Enumeration Members

        Check +DropdownMenuItemType | platform-bible-react

        Enumeration DropdownMenuItemType

        Enumeration Members

        Check Radio -

        Enumeration Members

        Check

        Check: 0

        Radio

        Radio: 1

        Settings

        Member Visibility

        Theme

        On This Page

        CheckRadio
        \ No newline at end of file +

        Enumeration Members

        Check

        Check: 0

        Radio

        Radio: 1

        Settings

        Member Visibility

        Theme

        On This Page

        CheckRadio
        \ No newline at end of file diff --git a/platform-bible-react/enums/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index 570ffa1163..ff009b9875 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

        Enumeration LabelPosition

        Enumeration Members

        Above After Before Below -

        Enumeration Members

        Above

        Above: "above"

        After

        After: "after"

        Before

        Before: "before"

        Below

        Below: "below"

        Settings

        Member Visibility

        Theme

        On This Page

        AboveAfterBeforeBelow
        \ No newline at end of file +

        Enumeration Members

        Above

        Above: "above"

        After

        After: "after"

        Before

        Before: "before"

        Below

        Below: "below"

        Settings

        Member Visibility

        Theme

        On This Page

        AboveAfterBeforeBelow
        \ No newline at end of file diff --git a/platform-bible-react/functions/Alert.html b/platform-bible-react/functions/Alert.html index 54e1d93f02..9b53072bbe 100644 --- a/platform-bible-react/functions/Alert.html +++ b/platform-bible-react/functions/Alert.html @@ -1,4 +1,4 @@ -Alert | platform-bible-react

        Function Alert

        Properties

        $$typeof +Alert | platform-bible-react

        Function Alert

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertDescription.html b/platform-bible-react/functions/AlertDescription.html index e9b3764df4..90be619b57 100644 --- a/platform-bible-react/functions/AlertDescription.html +++ b/platform-bible-react/functions/AlertDescription.html @@ -1,4 +1,4 @@ -AlertDescription | platform-bible-react

        Function AlertDescription

        Properties

        $$typeof +AlertDescription | platform-bible-react

        Function AlertDescription

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertTitle.html b/platform-bible-react/functions/AlertTitle.html index a839c37716..9f87344c2a 100644 --- a/platform-bible-react/functions/AlertTitle.html +++ b/platform-bible-react/functions/AlertTitle.html @@ -1,4 +1,4 @@ -AlertTitle | platform-bible-react

        Function AlertTitle

        Properties

        $$typeof +AlertTitle | platform-bible-react

        Function AlertTitle

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/BookChapterControl.html b/platform-bible-react/functions/BookChapterControl.html index e77f025749..f5d44bba1e 100644 --- a/platform-bible-react/functions/BookChapterControl.html +++ b/platform-bible-react/functions/BookChapterControl.html @@ -1 +1 @@ -BookChapterControl | platform-bible-react

        Function BookChapterControl

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +BookChapterControl | platform-bible-react

        Function BookChapterControl

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index 19551de8cb..ea047d3096 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ -Button | platform-bible-react

        Function Button

        Properties

        $$typeof +Button | platform-bible-react

        Function Button

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Card.html b/platform-bible-react/functions/Card.html index f67de5413b..5542f06353 100644 --- a/platform-bible-react/functions/Card.html +++ b/platform-bible-react/functions/Card.html @@ -1,4 +1,4 @@ -Card | platform-bible-react

        Function Card

        Properties

        $$typeof +Card | platform-bible-react

        Function Card

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardContent.html b/platform-bible-react/functions/CardContent.html index 5060983373..481acab43a 100644 --- a/platform-bible-react/functions/CardContent.html +++ b/platform-bible-react/functions/CardContent.html @@ -1,4 +1,4 @@ -CardContent | platform-bible-react

        Function CardContent

        Properties

        $$typeof +CardContent | platform-bible-react

        Function CardContent

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardDescription.html b/platform-bible-react/functions/CardDescription.html index 897a42d873..ab898872af 100644 --- a/platform-bible-react/functions/CardDescription.html +++ b/platform-bible-react/functions/CardDescription.html @@ -1,4 +1,4 @@ -CardDescription | platform-bible-react

        Function CardDescription

        Properties

        $$typeof +CardDescription | platform-bible-react

        Function CardDescription

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardFooter.html b/platform-bible-react/functions/CardFooter.html index 5b41f47619..9cd61b1373 100644 --- a/platform-bible-react/functions/CardFooter.html +++ b/platform-bible-react/functions/CardFooter.html @@ -1,4 +1,4 @@ -CardFooter | platform-bible-react

        Function CardFooter

        Properties

        $$typeof +CardFooter | platform-bible-react

        Function CardFooter

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardHeader.html b/platform-bible-react/functions/CardHeader.html index c5aeeb65ba..e19176d4be 100644 --- a/platform-bible-react/functions/CardHeader.html +++ b/platform-bible-react/functions/CardHeader.html @@ -1,4 +1,4 @@ -CardHeader | platform-bible-react

        Function CardHeader

        Properties

        $$typeof +CardHeader | platform-bible-react

        Function CardHeader

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardTitle.html b/platform-bible-react/functions/CardTitle.html index c3a1021a09..50193e9482 100644 --- a/platform-bible-react/functions/CardTitle.html +++ b/platform-bible-react/functions/CardTitle.html @@ -1,4 +1,4 @@ -CardTitle | platform-bible-react

        Function CardTitle

        Properties

        $$typeof +CardTitle | platform-bible-react

        Function CardTitle

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index 15b4b6e63a..b92b3a49c5 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

        Function ChapterRangeSelector

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ChapterRangeSelector | platform-bible-react

        Function ChapterRangeSelector

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index 68ccce5974..06556729c9 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,2 +1,2 @@ Checkbox | platform-bible-react

        Function Checkbox

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Checklist.html b/platform-bible-react/functions/Checklist.html index e69341cca3..aed373cd98 100644 --- a/platform-bible-react/functions/Checklist.html +++ b/platform-bible-react/functions/Checklist.html @@ -1,3 +1,3 @@ Checklist | platform-bible-react

        Function Checklist

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 1ae1c2d6b5..13e92dc980 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react

        Function ComboBox

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/ContextMenu.html b/platform-bible-react/functions/ContextMenu.html index 11a719a712..70a37826b7 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)

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/DataTable.html b/platform-bible-react/functions/DataTable.html index 1ab1c97756..17991b4003 100644 --- a/platform-bible-react/functions/DataTable.html +++ b/platform-bible-react/functions/DataTable.html @@ -1 +1 @@ -DataTable | platform-bible-react

        Function DataTable

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DataTable | platform-bible-react

        Function DataTable

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/DisableButton.html b/platform-bible-react/functions/DisableButton.html index f333640440..dbc190cb27 100644 --- a/platform-bible-react/functions/DisableButton.html +++ b/platform-bible-react/functions/DisableButton.html @@ -1,4 +1,4 @@ DisableButton | platform-bible-react

        Function DisableButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/DropdownMenu.html b/platform-bible-react/functions/DropdownMenu.html index 1836094de1..682f2eaa2d 100644 --- a/platform-bible-react/functions/DropdownMenu.html +++ b/platform-bible-react/functions/DropdownMenu.html @@ -1,4 +1,4 @@ -DropdownMenu | platform-bible-react

        Function DropdownMenu

        Properties

        contextTypes? +DropdownMenu | platform-bible-react

        Function DropdownMenu

        Properties

        contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuCheckboxItem.html b/platform-bible-react/functions/DropdownMenuCheckboxItem.html index fc59f944fd..2ba6030b96 100644 --- a/platform-bible-react/functions/DropdownMenuCheckboxItem.html +++ b/platform-bible-react/functions/DropdownMenuCheckboxItem.html @@ -1,4 +1,4 @@ -DropdownMenuCheckboxItem | platform-bible-react

        Function DropdownMenuCheckboxItem

        Properties

        $$typeof +DropdownMenuCheckboxItem | platform-bible-react

        Function DropdownMenuCheckboxItem

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuContent.html b/platform-bible-react/functions/DropdownMenuContent.html index 334d5104f8..2d72fb42ce 100644 --- a/platform-bible-react/functions/DropdownMenuContent.html +++ b/platform-bible-react/functions/DropdownMenuContent.html @@ -1,4 +1,4 @@ -DropdownMenuContent | platform-bible-react

        Function DropdownMenuContent

        Properties

        $$typeof +DropdownMenuContent | platform-bible-react

        Function DropdownMenuContent

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuGroup.html b/platform-bible-react/functions/DropdownMenuGroup.html index a170ae36cd..2a9b72f761 100644 --- a/platform-bible-react/functions/DropdownMenuGroup.html +++ b/platform-bible-react/functions/DropdownMenuGroup.html @@ -1,4 +1,4 @@ -DropdownMenuGroup | platform-bible-react

        Function DropdownMenuGroup

        Properties

        $$typeof +DropdownMenuGroup | platform-bible-react

        Function DropdownMenuGroup

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuItem.html b/platform-bible-react/functions/DropdownMenuItem.html index 461b87eab2..a055de712a 100644 --- a/platform-bible-react/functions/DropdownMenuItem.html +++ b/platform-bible-react/functions/DropdownMenuItem.html @@ -1,6 +1,6 @@ DropdownMenuItem | platform-bible-react

        Function DropdownMenuItem

        • DropdownMenuItem(props): ReactNode

        • TODO: fix: direction is not automatically handled by this component, so that shortcuts are display always to the right

          -

          Parameters

          • props: Omit<DropdownMenuItemProps & RefAttributes<HTMLDivElement>, "ref"> & {
                className?: string;
                inset?: boolean;
            } & RefAttributes<HTMLDivElement>

          Returns ReactNode

        Properties

        $$typeof +

        Parameters

        • props: Omit<DropdownMenuItemProps & RefAttributes<HTMLDivElement>, "ref"> & {
              className?: string;
              inset?: boolean;
          } & RefAttributes<HTMLDivElement>

        Returns ReactNode

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuLabel.html b/platform-bible-react/functions/DropdownMenuLabel.html index d7a0508aab..41da06b173 100644 --- a/platform-bible-react/functions/DropdownMenuLabel.html +++ b/platform-bible-react/functions/DropdownMenuLabel.html @@ -1,4 +1,4 @@ -DropdownMenuLabel | platform-bible-react

        Function DropdownMenuLabel

        Properties

        $$typeof +DropdownMenuLabel | platform-bible-react

        Function DropdownMenuLabel

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuPortal.html b/platform-bible-react/functions/DropdownMenuPortal.html index 738e2542b7..ff3858467c 100644 --- a/platform-bible-react/functions/DropdownMenuPortal.html +++ b/platform-bible-react/functions/DropdownMenuPortal.html @@ -1,4 +1,4 @@ -DropdownMenuPortal | platform-bible-react

        Function DropdownMenuPortal

        Properties

        contextTypes? +DropdownMenuPortal | platform-bible-react

        Function DropdownMenuPortal

        Properties

        contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioGroup.html b/platform-bible-react/functions/DropdownMenuRadioGroup.html index a93d3bc532..968bc76cdc 100644 --- a/platform-bible-react/functions/DropdownMenuRadioGroup.html +++ b/platform-bible-react/functions/DropdownMenuRadioGroup.html @@ -1,4 +1,4 @@ -DropdownMenuRadioGroup | platform-bible-react

        Function DropdownMenuRadioGroup

        Properties

        $$typeof +DropdownMenuRadioGroup | platform-bible-react

        Function DropdownMenuRadioGroup

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioItem.html b/platform-bible-react/functions/DropdownMenuRadioItem.html index 7004197700..4e217e5af0 100644 --- a/platform-bible-react/functions/DropdownMenuRadioItem.html +++ b/platform-bible-react/functions/DropdownMenuRadioItem.html @@ -1,4 +1,4 @@ -DropdownMenuRadioItem | platform-bible-react

        Function DropdownMenuRadioItem

        Properties

        $$typeof +DropdownMenuRadioItem | platform-bible-react

        Function DropdownMenuRadioItem

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSeparator.html b/platform-bible-react/functions/DropdownMenuSeparator.html index 91132bfcde..74957b1d7a 100644 --- a/platform-bible-react/functions/DropdownMenuSeparator.html +++ b/platform-bible-react/functions/DropdownMenuSeparator.html @@ -1,4 +1,4 @@ -DropdownMenuSeparator | platform-bible-react

        Function DropdownMenuSeparator

        Properties

        $$typeof +DropdownMenuSeparator | platform-bible-react

        Function DropdownMenuSeparator

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuShortcut.html b/platform-bible-react/functions/DropdownMenuShortcut.html index 74f23b5c82..2636c57439 100644 --- a/platform-bible-react/functions/DropdownMenuShortcut.html +++ b/platform-bible-react/functions/DropdownMenuShortcut.html @@ -1,2 +1,2 @@ -DropdownMenuShortcut | platform-bible-react

        Function DropdownMenuShortcut

        Properties

        displayName -

        Properties

        displayName

        displayName: string

        Settings

        Member Visibility

        Theme

        On This Page

        displayName
        \ No newline at end of file +DropdownMenuShortcut | platform-bible-react

        Function DropdownMenuShortcut

        Properties

        displayName +

        Properties

        displayName

        displayName: string

        Settings

        Member Visibility

        Theme

        On This Page

        displayName
        \ No newline at end of file diff --git a/platform-bible-react/functions/DropdownMenuSub.html b/platform-bible-react/functions/DropdownMenuSub.html index dc7d6a28f2..15c12050a7 100644 --- a/platform-bible-react/functions/DropdownMenuSub.html +++ b/platform-bible-react/functions/DropdownMenuSub.html @@ -1,4 +1,4 @@ -DropdownMenuSub | platform-bible-react

        Function DropdownMenuSub

        Properties

        contextTypes? +DropdownMenuSub | platform-bible-react

        Function DropdownMenuSub

        Properties

        contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubContent.html b/platform-bible-react/functions/DropdownMenuSubContent.html index ae1bc0c267..b9c67e4515 100644 --- a/platform-bible-react/functions/DropdownMenuSubContent.html +++ b/platform-bible-react/functions/DropdownMenuSubContent.html @@ -1,4 +1,4 @@ -DropdownMenuSubContent | platform-bible-react

        Function DropdownMenuSubContent

        Properties

        $$typeof +DropdownMenuSubContent | platform-bible-react

        Function DropdownMenuSubContent

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubTrigger.html b/platform-bible-react/functions/DropdownMenuSubTrigger.html index bf3a76aff1..57f2234eda 100644 --- a/platform-bible-react/functions/DropdownMenuSubTrigger.html +++ b/platform-bible-react/functions/DropdownMenuSubTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuSubTrigger | platform-bible-react

        Function DropdownMenuSubTrigger

        Properties

        $$typeof +DropdownMenuSubTrigger | platform-bible-react

        Function DropdownMenuSubTrigger

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuTrigger.html b/platform-bible-react/functions/DropdownMenuTrigger.html index f46f573cbe..6a72ac7f73 100644 --- a/platform-bible-react/functions/DropdownMenuTrigger.html +++ b/platform-bible-react/functions/DropdownMenuTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuTrigger | platform-bible-react

        Function DropdownMenuTrigger

        Properties

        $$typeof +DropdownMenuTrigger | platform-bible-react

        Function DropdownMenuTrigger

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/EnableButton.html b/platform-bible-react/functions/EnableButton.html index 936b8b4479..5b43e4bf67 100644 --- a/platform-bible-react/functions/EnableButton.html +++ b/platform-bible-react/functions/EnableButton.html @@ -1,4 +1,4 @@ EnableButton | platform-bible-react

        Function EnableButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/FilterButton.html b/platform-bible-react/functions/FilterButton.html index 34015b2977..fc2ac41e73 100644 --- a/platform-bible-react/functions/FilterButton.html +++ b/platform-bible-react/functions/FilterButton.html @@ -2,7 +2,7 @@ to be used with the dropdown menu. It uses forwardRef to pass the button to the dropdown trigger asChild.

        Parameters

        • props: RefAttributes<HTMLButtonElement>

        Returns ReactNode

        A button that can be used to filter.

        -

        Properties

        $$typeof +

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/FilterDropdown.html b/platform-bible-react/functions/FilterDropdown.html index a2b4fd93ce..816536f0f0 100644 --- a/platform-bible-react/functions/FilterDropdown.html +++ b/platform-bible-react/functions/FilterDropdown.html @@ -1,4 +1,4 @@ FilterDropdown | platform-bible-react

        Function FilterDropdown

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Footer.html b/platform-bible-react/functions/Footer.html index 3f5c8a0168..db4227b265 100644 --- a/platform-bible-react/functions/Footer.html +++ b/platform-bible-react/functions/Footer.html @@ -1,4 +1,4 @@ Footer | platform-bible-react

        Function Footer

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index 2bc8682335..3d9b34ea69 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react

        Function GridMenu

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +GridMenu | platform-bible-react

        Function GridMenu

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index f5cdc4b859..4afbe654bb 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

        Function HamburgerMenuButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +HamburgerMenuButton | platform-bible-react

        Function HamburgerMenuButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index d3e5832502..34d76539dc 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react

        Function IconButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Input.html b/platform-bible-react/functions/Input.html index 1077fe2c29..da8ccc7d97 100644 --- a/platform-bible-react/functions/Input.html +++ b/platform-bible-react/functions/Input.html @@ -1,4 +1,4 @@ -Input | platform-bible-react

        Function Input

        Properties

        $$typeof +Input | platform-bible-react

        Function Input

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/InstallButton.html b/platform-bible-react/functions/InstallButton.html index 25cbb46dc1..6dd82ddb81 100644 --- a/platform-bible-react/functions/InstallButton.html +++ b/platform-bible-react/functions/InstallButton.html @@ -1,4 +1,4 @@ InstallButton | platform-bible-react

        Function InstallButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Inventory.html b/platform-bible-react/functions/Inventory.html index 414b6873a3..d4103141d2 100644 --- a/platform-bible-react/functions/Inventory.html +++ b/platform-bible-react/functions/Inventory.html @@ -1 +1 @@ -Inventory | platform-bible-react

        Function Inventory

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +Inventory | platform-bible-react

        Function Inventory

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Label.html b/platform-bible-react/functions/Label.html index 84d993f178..f07efd0645 100644 --- a/platform-bible-react/functions/Label.html +++ b/platform-bible-react/functions/Label.html @@ -1,4 +1,4 @@ -Label | platform-bible-react

        Function Label

        Properties

        $$typeof +Label | platform-bible-react

        Function Label

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/MarkdownRenderer.html b/platform-bible-react/functions/MarkdownRenderer.html index aaa8ab7f88..1ff541514f 100644 --- a/platform-bible-react/functions/MarkdownRenderer.html +++ b/platform-bible-react/functions/MarkdownRenderer.html @@ -1,4 +1,4 @@ MarkdownRenderer | platform-bible-react

        Function MarkdownRenderer

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 41fca74bb6..1ba5aa6c6e 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react

        Function MenuItem

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +MenuItem | platform-bible-react

        Function MenuItem

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/MoreInfo.html b/platform-bible-react/functions/MoreInfo.html index 6a20e23c88..f6a72aa9a5 100644 --- a/platform-bible-react/functions/MoreInfo.html +++ b/platform-bible-react/functions/MoreInfo.html @@ -4,4 +4,4 @@
      • Returns the more info component that displays the category, number of downloads, languages, and links to the website and support
        • -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/NoExtensionsFound.html b/platform-bible-react/functions/NoExtensionsFound.html index 2e95341d98..7e681fe568 100644 --- a/platform-bible-react/functions/NoExtensionsFound.html +++ b/platform-bible-react/functions/NoExtensionsFound.html @@ -2,4 +2,4 @@

        Parameters

        • __namedParameters: NoExtensionsFoundProps

        Returns Element

        • Returns the message component that displays the message to the user.
        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/ScriptureResultsViewer.html b/platform-bible-react/functions/ScriptureResultsViewer.html index 403dd9799b..cbfc307820 100644 --- a/platform-bible-react/functions/ScriptureResultsViewer.html +++ b/platform-bible-react/functions/ScriptureResultsViewer.html @@ -5,4 +5,4 @@ displays somewhat "tree-like" which allows it to be more horizontally compact and intuitive. But it also has the option of displaying as a traditional table with column headings (with or without the source column showing).

        -

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index 06fd3dfcd6..b57a2d6c4c 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react

        Function SearchBar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +SearchBar | platform-bible-react

        Function SearchBar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Select.html b/platform-bible-react/functions/Select.html index 12fbca6851..8f82666208 100644 --- a/platform-bible-react/functions/Select.html +++ b/platform-bible-react/functions/Select.html @@ -1,4 +1,4 @@ -Select | platform-bible-react

        Function Select

        Properties

        contextTypes? +Select | platform-bible-react

        Function Select

        Properties

        contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectContent.html b/platform-bible-react/functions/SelectContent.html index d622f5a637..26cdf35bf4 100644 --- a/platform-bible-react/functions/SelectContent.html +++ b/platform-bible-react/functions/SelectContent.html @@ -1,4 +1,4 @@ -SelectContent | platform-bible-react

        Function SelectContent

        Properties

        $$typeof +SelectContent | platform-bible-react

        Function SelectContent

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectGroup.html b/platform-bible-react/functions/SelectGroup.html index a2c5a8af0a..f2f73241c4 100644 --- a/platform-bible-react/functions/SelectGroup.html +++ b/platform-bible-react/functions/SelectGroup.html @@ -1,4 +1,4 @@ -SelectGroup | platform-bible-react

        Function SelectGroup

        Properties

        $$typeof +SelectGroup | platform-bible-react

        Function SelectGroup

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectItem.html b/platform-bible-react/functions/SelectItem.html index 0f933aad91..c53c5d455c 100644 --- a/platform-bible-react/functions/SelectItem.html +++ b/platform-bible-react/functions/SelectItem.html @@ -1,4 +1,4 @@ -SelectItem | platform-bible-react

        Function SelectItem

        Properties

        $$typeof +SelectItem | platform-bible-react

        Function SelectItem

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectLabel.html b/platform-bible-react/functions/SelectLabel.html index 170664eed1..30d414e2b6 100644 --- a/platform-bible-react/functions/SelectLabel.html +++ b/platform-bible-react/functions/SelectLabel.html @@ -1,4 +1,4 @@ -SelectLabel | platform-bible-react

        Function SelectLabel

        Properties

        $$typeof +SelectLabel | platform-bible-react

        Function SelectLabel

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollDownButton.html b/platform-bible-react/functions/SelectScrollDownButton.html index bcfa463cc1..b7bc96135b 100644 --- a/platform-bible-react/functions/SelectScrollDownButton.html +++ b/platform-bible-react/functions/SelectScrollDownButton.html @@ -1,4 +1,4 @@ -SelectScrollDownButton | platform-bible-react

        Function SelectScrollDownButton

        Properties

        $$typeof +SelectScrollDownButton | platform-bible-react

        Function SelectScrollDownButton

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollUpButton.html b/platform-bible-react/functions/SelectScrollUpButton.html index d63640f8fe..92ffe3ef11 100644 --- a/platform-bible-react/functions/SelectScrollUpButton.html +++ b/platform-bible-react/functions/SelectScrollUpButton.html @@ -1,4 +1,4 @@ -SelectScrollUpButton | platform-bible-react

        Function SelectScrollUpButton

        Properties

        $$typeof +SelectScrollUpButton | platform-bible-react

        Function SelectScrollUpButton

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectSeparator.html b/platform-bible-react/functions/SelectSeparator.html index 0a3e57bcd7..21df4b1fa6 100644 --- a/platform-bible-react/functions/SelectSeparator.html +++ b/platform-bible-react/functions/SelectSeparator.html @@ -1,4 +1,4 @@ -SelectSeparator | platform-bible-react

        Function SelectSeparator

        Properties

        $$typeof +SelectSeparator | platform-bible-react

        Function SelectSeparator

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectTrigger.html b/platform-bible-react/functions/SelectTrigger.html index 5d820c905a..f8932a312a 100644 --- a/platform-bible-react/functions/SelectTrigger.html +++ b/platform-bible-react/functions/SelectTrigger.html @@ -1,4 +1,4 @@ -SelectTrigger | platform-bible-react

        Function SelectTrigger

        Properties

        $$typeof +SelectTrigger | platform-bible-react

        Function SelectTrigger

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectValue.html b/platform-bible-react/functions/SelectValue.html index 61b8ed49a0..42bbb30ce0 100644 --- a/platform-bible-react/functions/SelectValue.html +++ b/platform-bible-react/functions/SelectValue.html @@ -1,4 +1,4 @@ -SelectValue | platform-bible-react

        Function SelectValue

        Properties

        $$typeof +SelectValue | platform-bible-react

        Function SelectValue

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ShadCnSlider.html b/platform-bible-react/functions/ShadCnSlider.html index a30bdaeeda..a2f5f5aa83 100644 --- a/platform-bible-react/functions/ShadCnSlider.html +++ b/platform-bible-react/functions/ShadCnSlider.html @@ -1,4 +1,4 @@ -ShadCnSlider | platform-bible-react

        Function ShadCnSlider

        Properties

        $$typeof +ShadCnSlider | platform-bible-react

        Function ShadCnSlider

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ShadCnSwitch.html b/platform-bible-react/functions/ShadCnSwitch.html index 7f7b9c800a..838c8da0cd 100644 --- a/platform-bible-react/functions/ShadCnSwitch.html +++ b/platform-bible-react/functions/ShadCnSwitch.html @@ -1,4 +1,4 @@ -ShadCnSwitch | platform-bible-react

        Function ShadCnSwitch

        Properties

        $$typeof +ShadCnSwitch | platform-bible-react

        Function ShadCnSwitch

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index 90790efbe8..ce3a6c9747 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ Slider | platform-bible-react

        Function Slider

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Snackbar.html b/platform-bible-react/functions/Snackbar.html index c5dd7732f1..30d9e78d45 100644 --- a/platform-bible-react/functions/Snackbar.html +++ b/platform-bible-react/functions/Snackbar.html @@ -1,4 +1,4 @@ Snackbar | platform-bible-react

        Function Snackbar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index 41c51d1a41..d5cd23c002 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ Switch | platform-bible-react

        Function Switch

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index a3b9eff9ad..00b06aedf4 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ -Table | platform-bible-react

        Function Table

        Properties

        $$typeof +Table | platform-bible-react

        Function Table

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableBody.html b/platform-bible-react/functions/TableBody.html index 39130c9496..b80c470259 100644 --- a/platform-bible-react/functions/TableBody.html +++ b/platform-bible-react/functions/TableBody.html @@ -1,4 +1,4 @@ -TableBody | platform-bible-react

        Function TableBody

        Properties

        $$typeof +TableBody | platform-bible-react

        Function TableBody

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCaption.html b/platform-bible-react/functions/TableCaption.html index e2cc80f52c..34d764a98e 100644 --- a/platform-bible-react/functions/TableCaption.html +++ b/platform-bible-react/functions/TableCaption.html @@ -1,4 +1,4 @@ -TableCaption | platform-bible-react

        Function TableCaption

        Properties

        $$typeof +TableCaption | platform-bible-react

        Function TableCaption

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCell.html b/platform-bible-react/functions/TableCell.html index e7745daf22..6223d061f3 100644 --- a/platform-bible-react/functions/TableCell.html +++ b/platform-bible-react/functions/TableCell.html @@ -1,4 +1,4 @@ -TableCell | platform-bible-react

        Function TableCell

        Properties

        $$typeof +TableCell | platform-bible-react

        Function TableCell

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableFooter.html b/platform-bible-react/functions/TableFooter.html index 0edf7f8aa4..6349fdff9e 100644 --- a/platform-bible-react/functions/TableFooter.html +++ b/platform-bible-react/functions/TableFooter.html @@ -1,4 +1,4 @@ -TableFooter | platform-bible-react

        Function TableFooter

        Properties

        $$typeof +TableFooter | platform-bible-react

        Function TableFooter

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHead.html b/platform-bible-react/functions/TableHead.html index b165dad79d..66c2bbd156 100644 --- a/platform-bible-react/functions/TableHead.html +++ b/platform-bible-react/functions/TableHead.html @@ -1,4 +1,4 @@ -TableHead | platform-bible-react

        Function TableHead

        Properties

        $$typeof +TableHead | platform-bible-react

        Function TableHead

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHeader.html b/platform-bible-react/functions/TableHeader.html index e5995a256e..961614b0d2 100644 --- a/platform-bible-react/functions/TableHeader.html +++ b/platform-bible-react/functions/TableHeader.html @@ -1,4 +1,4 @@ -TableHeader | platform-bible-react

        Function TableHeader

        Properties

        $$typeof +TableHeader | platform-bible-react

        Function TableHeader

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableRow.html b/platform-bible-react/functions/TableRow.html index 54f69139bc..44f6f23797 100644 --- a/platform-bible-react/functions/TableRow.html +++ b/platform-bible-react/functions/TableRow.html @@ -1,4 +1,4 @@ -TableRow | platform-bible-react

        Function TableRow

        Properties

        $$typeof +TableRow | platform-bible-react

        Function TableRow

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Tabs.html b/platform-bible-react/functions/Tabs.html index 398d56641c..360c16ad70 100644 --- a/platform-bible-react/functions/Tabs.html +++ b/platform-bible-react/functions/Tabs.html @@ -1,4 +1,4 @@ -Tabs | platform-bible-react

        Function Tabs

        Properties

        $$typeof +Tabs | platform-bible-react

        Function Tabs

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsContent.html b/platform-bible-react/functions/TabsContent.html index 556bd90fa3..dd6e580416 100644 --- a/platform-bible-react/functions/TabsContent.html +++ b/platform-bible-react/functions/TabsContent.html @@ -1,4 +1,4 @@ -TabsContent | platform-bible-react

        Function TabsContent

        Properties

        $$typeof +TabsContent | platform-bible-react

        Function TabsContent

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsList.html b/platform-bible-react/functions/TabsList.html index ab4f10efb1..520cdc07be 100644 --- a/platform-bible-react/functions/TabsList.html +++ b/platform-bible-react/functions/TabsList.html @@ -1,4 +1,4 @@ -TabsList | platform-bible-react

        Function TabsList

        Properties

        $$typeof +TabsList | platform-bible-react

        Function TabsList

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsTrigger.html b/platform-bible-react/functions/TabsTrigger.html index cc04f1957d..b31baef624 100644 --- a/platform-bible-react/functions/TabsTrigger.html +++ b/platform-bible-react/functions/TabsTrigger.html @@ -1,4 +1,4 @@ -TabsTrigger | platform-bible-react

        Function TabsTrigger

        Properties

        $$typeof +TabsTrigger | platform-bible-react

        Function TabsTrigger

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index 1497c01a58..2ae13fe2f8 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react

        Function TextField

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Element

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index 36ba4be364..7f146ed45a 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react

        Function Toolbar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +Toolbar | platform-bible-react

        Function Toolbar

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/UpdateButton.html b/platform-bible-react/functions/UpdateButton.html index 37215d5d4a..c81a334936 100644 --- a/platform-bible-react/functions/UpdateButton.html +++ b/platform-bible-react/functions/UpdateButton.html @@ -1,4 +1,4 @@ UpdateButton | platform-bible-react

        Function UpdateButton

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/VersionHistory.html b/platform-bible-react/functions/VersionHistory.html index 14f3e630f8..c823621e6d 100644 --- a/platform-bible-react/functions/VersionHistory.html +++ b/platform-bible-react/functions/VersionHistory.html @@ -1,4 +1,4 @@ VersionHistory | platform-bible-react

        Function VersionHistory

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/VerticalTabs.html b/platform-bible-react/functions/VerticalTabs.html index 0a21389b22..ff46369887 100644 --- a/platform-bible-react/functions/VerticalTabs.html +++ b/platform-bible-react/functions/VerticalTabs.html @@ -1,4 +1,4 @@ -VerticalTabs | platform-bible-react

        Function VerticalTabs

        Properties

        $$typeof +VerticalTabs | platform-bible-react

        Function VerticalTabs

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsContent.html b/platform-bible-react/functions/VerticalTabsContent.html index 043d9c9df4..e9cad5bc50 100644 --- a/platform-bible-react/functions/VerticalTabsContent.html +++ b/platform-bible-react/functions/VerticalTabsContent.html @@ -1,4 +1,4 @@ -VerticalTabsContent | platform-bible-react

        Function VerticalTabsContent

        Properties

        $$typeof +VerticalTabsContent | platform-bible-react

        Function VerticalTabsContent

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsList.html b/platform-bible-react/functions/VerticalTabsList.html index 66785c1136..22463323f7 100644 --- a/platform-bible-react/functions/VerticalTabsList.html +++ b/platform-bible-react/functions/VerticalTabsList.html @@ -1,4 +1,4 @@ -VerticalTabsList | platform-bible-react

        Function VerticalTabsList

        Properties

        $$typeof +VerticalTabsList | platform-bible-react

        Function VerticalTabsList

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsTrigger.html b/platform-bible-react/functions/VerticalTabsTrigger.html index fcda015d01..7814fd56ac 100644 --- a/platform-bible-react/functions/VerticalTabsTrigger.html +++ b/platform-bible-react/functions/VerticalTabsTrigger.html @@ -1,4 +1,4 @@ -VerticalTabsTrigger | platform-bible-react

        Function VerticalTabsTrigger

        Properties

        $$typeof +VerticalTabsTrigger | platform-bible-react

        Function VerticalTabsTrigger

        Properties

        $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/buttonVariants.html b/platform-bible-react/functions/buttonVariants.html index 7d47d327ec..a02e08c273 100644 --- a/platform-bible-react/functions/buttonVariants.html +++ b/platform-bible-react/functions/buttonVariants.html @@ -1 +1 @@ -buttonVariants | platform-bible-react

        Function buttonVariants

        • buttonVariants(props?): string

        • Parameters

          • Optional props: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

          Returns string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +buttonVariants | platform-bible-react

        Function buttonVariants

        • buttonVariants(props?): string

        • Parameters

          • Optional props: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

          Returns string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/getSortingIcon.html b/platform-bible-react/functions/getSortingIcon.html index fe619be760..5465a7098f 100644 --- a/platform-bible-react/functions/getSortingIcon.html +++ b/platform-bible-react/functions/getSortingIcon.html @@ -1 +1 @@ -getSortingIcon | platform-bible-react

        Function getSortingIcon

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +getSortingIcon | platform-bible-react

        Function getSortingIcon

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/inventoryCountColumn.html b/platform-bible-react/functions/inventoryCountColumn.html index 73d88aa6a7..7f86942ed9 100644 --- a/platform-bible-react/functions/inventoryCountColumn.html +++ b/platform-bible-react/functions/inventoryCountColumn.html @@ -1 +1 @@ -inventoryCountColumn | platform-bible-react

        Function inventoryCountColumn

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +inventoryCountColumn | platform-bible-react

        Function inventoryCountColumn

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/inventoryItemColumn.html b/platform-bible-react/functions/inventoryItemColumn.html index c12a24f8ee..52bd43f4c5 100644 --- a/platform-bible-react/functions/inventoryItemColumn.html +++ b/platform-bible-react/functions/inventoryItemColumn.html @@ -1 +1 @@ -inventoryItemColumn | platform-bible-react

        Function inventoryItemColumn

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +inventoryItemColumn | platform-bible-react

        Function inventoryItemColumn

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/inventoryStatusColumn.html b/platform-bible-react/functions/inventoryStatusColumn.html index 8a73dcd3d8..c5a7a02cc1 100644 --- a/platform-bible-react/functions/inventoryStatusColumn.html +++ b/platform-bible-react/functions/inventoryStatusColumn.html @@ -1 +1 @@ -inventoryStatusColumn | platform-bible-react

        Function inventoryStatusColumn

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +inventoryStatusColumn | platform-bible-react

        Function inventoryStatusColumn

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index bdb8c36b9e..8e950ef14d 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index d4c213acb6..263fb0e7c8 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index e2f0e3f927..e9309402bf 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
        • -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/ButtonProps.html b/platform-bible-react/interfaces/ButtonProps.html index b120c7cc58..dd222b8531 100644 --- a/platform-bible-react/interfaces/ButtonProps.html +++ b/platform-bible-react/interfaces/ButtonProps.html @@ -1,4 +1,4 @@ -ButtonProps | platform-bible-react

        Interface ButtonProps

        interface ButtonProps {
            about?: string;
            accessKey?: string;
            aria-activedescendant?: string;
            aria-atomic?: Booleanish;
            aria-autocomplete?: "inline" | "both" | "none" | "list";
            aria-braillelabel?: string;
            aria-brailleroledescription?: string;
            aria-busy?: Booleanish;
            aria-checked?: boolean | "false" | "mixed" | "true";
            aria-colcount?: number;
            aria-colindex?: number;
            aria-colindextext?: string;
            aria-colspan?: number;
            aria-controls?: string;
            aria-current?: boolean | "false" | "time" | "location" | "page" | "true" | "step" | "date";
            aria-describedby?: string;
            aria-description?: string;
            aria-details?: string;
            aria-disabled?: Booleanish;
            aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup";
            aria-errormessage?: string;
            aria-expanded?: Booleanish;
            aria-flowto?: string;
            aria-grabbed?: Booleanish;
            aria-haspopup?: boolean | "false" | "grid" | "dialog" | "menu" | "listbox" | "true" | "tree";
            aria-hidden?: Booleanish;
            aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling";
            aria-keyshortcuts?: string;
            aria-label?: string;
            aria-labelledby?: string;
            aria-level?: number;
            aria-live?: "off" | "assertive" | "polite";
            aria-modal?: Booleanish;
            aria-multiline?: Booleanish;
            aria-multiselectable?: Booleanish;
            aria-orientation?: "horizontal" | "vertical";
            aria-owns?: string;
            aria-placeholder?: string;
            aria-posinset?: number;
            aria-pressed?: boolean | "false" | "mixed" | "true";
            aria-readonly?: Booleanish;
            aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
            aria-required?: Booleanish;
            aria-roledescription?: string;
            aria-rowcount?: number;
            aria-rowindex?: number;
            aria-rowindextext?: string;
            aria-rowspan?: number;
            aria-selected?: Booleanish;
            aria-setsize?: number;
            aria-sort?: "none" | "other" | "ascending" | "descending";
            aria-valuemax?: number;
            aria-valuemin?: number;
            aria-valuenow?: number;
            aria-valuetext?: string;
            asChild?: boolean;
            autoCapitalize?: string;
            autoCorrect?: string;
            autoFocus?: boolean;
            autoSave?: string;
            children?: ReactNode;
            className?: string;
            color?: string;
            content?: string;
            contentEditable?: "inherit" | Booleanish | "plaintext-only";
            contextMenu?: string;
            dangerouslySetInnerHTML?: {
                __html: string | TrustedHTML;
            };
            datatype?: string;
            defaultChecked?: boolean;
            defaultValue?: string | number | readonly string[];
            dir?: string;
            disabled?: boolean;
            draggable?: Booleanish;
            form?: string;
            formAction?: string;
            formEncType?: string;
            formMethod?: string;
            formNoValidate?: boolean;
            formTarget?: string;
            hidden?: boolean;
            id?: string;
            inlist?: any;
            inputMode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal";
            is?: string;
            itemID?: string;
            itemProp?: string;
            itemRef?: string;
            itemScope?: boolean;
            itemType?: string;
            lang?: string;
            name?: string;
            nonce?: string;
            onAbort?: ReactEventHandler<HTMLButtonElement>;
            onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
            onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
            onAuxClick?: MouseEventHandler<HTMLButtonElement>;
            onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
            onBeforeInput?: FormEventHandler<HTMLButtonElement>;
            onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
            onBlur?: FocusEventHandler<HTMLButtonElement>;
            onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
            onCanPlay?: ReactEventHandler<HTMLButtonElement>;
            onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
            onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
            onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
            onChange?: FormEventHandler<HTMLButtonElement>;
            onChangeCapture?: FormEventHandler<HTMLButtonElement>;
            onClick?: MouseEventHandler<HTMLButtonElement>;
            onClickCapture?: MouseEventHandler<HTMLButtonElement>;
            onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
            onContextMenu?: MouseEventHandler<HTMLButtonElement>;
            onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
            onCopy?: ClipboardEventHandler<HTMLButtonElement>;
            onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
            onCut?: ClipboardEventHandler<HTMLButtonElement>;
            onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
            onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
            onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
            onDrag?: DragEventHandler<HTMLButtonElement>;
            onDragCapture?: DragEventHandler<HTMLButtonElement>;
            onDragEnd?: DragEventHandler<HTMLButtonElement>;
            onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
            onDragEnter?: DragEventHandler<HTMLButtonElement>;
            onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
            onDragExit?: DragEventHandler<HTMLButtonElement>;
            onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
            onDragLeave?: DragEventHandler<HTMLButtonElement>;
            onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
            onDragOver?: DragEventHandler<HTMLButtonElement>;
            onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
            onDragStart?: DragEventHandler<HTMLButtonElement>;
            onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
            onDrop?: DragEventHandler<HTMLButtonElement>;
            onDropCapture?: DragEventHandler<HTMLButtonElement>;
            onDurationChange?: ReactEventHandler<HTMLButtonElement>;
            onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
            onEmptied?: ReactEventHandler<HTMLButtonElement>;
            onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
            onEncrypted?: ReactEventHandler<HTMLButtonElement>;
            onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
            onEnded?: ReactEventHandler<HTMLButtonElement>;
            onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
            onError?: ReactEventHandler<HTMLButtonElement>;
            onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
            onFocus?: FocusEventHandler<HTMLButtonElement>;
            onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
            onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
            onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
            onInput?: FormEventHandler<HTMLButtonElement>;
            onInputCapture?: FormEventHandler<HTMLButtonElement>;
            onInvalid?: FormEventHandler<HTMLButtonElement>;
            onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
            onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
            onLoad?: ReactEventHandler<HTMLButtonElement>;
            onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
            onLoadStart?: ReactEventHandler<HTMLButtonElement>;
            onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
            onLoadedData?: ReactEventHandler<HTMLButtonElement>;
            onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
            onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
            onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
            onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
            onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
            onMouseDown?: MouseEventHandler<HTMLButtonElement>;
            onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
            onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
            onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
            onMouseMove?: MouseEventHandler<HTMLButtonElement>;
            onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
            onMouseOut?: MouseEventHandler<HTMLButtonElement>;
            onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
            onMouseOver?: MouseEventHandler<HTMLButtonElement>;
            onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
            onMouseUp?: MouseEventHandler<HTMLButtonElement>;
            onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
            onPaste?: ClipboardEventHandler<HTMLButtonElement>;
            onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
            onPause?: ReactEventHandler<HTMLButtonElement>;
            onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
            onPlay?: ReactEventHandler<HTMLButtonElement>;
            onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
            onPlaying?: ReactEventHandler<HTMLButtonElement>;
            onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
            onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
            onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerDown?: PointerEventHandler<HTMLButtonElement>;
            onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
            onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
            onPointerMove?: PointerEventHandler<HTMLButtonElement>;
            onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerOut?: PointerEventHandler<HTMLButtonElement>;
            onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerOver?: PointerEventHandler<HTMLButtonElement>;
            onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerUp?: PointerEventHandler<HTMLButtonElement>;
            onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
            onProgress?: ReactEventHandler<HTMLButtonElement>;
            onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
            onRateChange?: ReactEventHandler<HTMLButtonElement>;
            onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
            onReset?: FormEventHandler<HTMLButtonElement>;
            onResetCapture?: FormEventHandler<HTMLButtonElement>;
            onResize?: ReactEventHandler<HTMLButtonElement>;
            onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
            onScroll?: UIEventHandler<HTMLButtonElement>;
            onScrollCapture?: UIEventHandler<HTMLButtonElement>;
            onSeeked?: ReactEventHandler<HTMLButtonElement>;
            onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
            onSeeking?: ReactEventHandler<HTMLButtonElement>;
            onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
            onSelect?: ReactEventHandler<HTMLButtonElement>;
            onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
            onStalled?: ReactEventHandler<HTMLButtonElement>;
            onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
            onSubmit?: FormEventHandler<HTMLButtonElement>;
            onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
            onSuspend?: ReactEventHandler<HTMLButtonElement>;
            onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
            onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
            onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
            onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
            onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
            onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
            onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
            onTouchMove?: TouchEventHandler<HTMLButtonElement>;
            onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
            onTouchStart?: TouchEventHandler<HTMLButtonElement>;
            onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
            onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
            onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
            onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
            onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
            onWaiting?: ReactEventHandler<HTMLButtonElement>;
            onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
            onWheel?: WheelEventHandler<HTMLButtonElement>;
            onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
            prefix?: string;
            property?: string;
            radioGroup?: string;
            rel?: string;
            resource?: string;
            results?: number;
            rev?: string;
            role?: AriaRole;
            security?: string;
            size?: null | "default" | "icon" | "sm" | "lg";
            slot?: string;
            spellCheck?: Booleanish;
            style?: CSSProperties;
            suppressContentEditableWarning?: boolean;
            suppressHydrationWarning?: boolean;
            tabIndex?: number;
            title?: string;
            translate?: "yes" | "no";
            type?: "button" | "reset" | "submit";
            typeof?: string;
            unselectable?: "off" | "on";
            value?: string | number | readonly string[];
            variant?: null | "link" | "default" | "outline" | "destructive" | "secondary" | "ghost";
            vocab?: string;
        }

        Hierarchy

        • ButtonHTMLAttributes<HTMLButtonElement>
        • VariantProps<typeof buttonVariants>
          • ButtonProps

        Properties

        about? +ButtonProps | platform-bible-react

        Interface ButtonProps

        interface ButtonProps {
            about?: string;
            accessKey?: string;
            aria-activedescendant?: string;
            aria-atomic?: Booleanish;
            aria-autocomplete?: "inline" | "both" | "none" | "list";
            aria-braillelabel?: string;
            aria-brailleroledescription?: string;
            aria-busy?: Booleanish;
            aria-checked?: boolean | "false" | "mixed" | "true";
            aria-colcount?: number;
            aria-colindex?: number;
            aria-colindextext?: string;
            aria-colspan?: number;
            aria-controls?: string;
            aria-current?: boolean | "false" | "time" | "location" | "page" | "true" | "step" | "date";
            aria-describedby?: string;
            aria-description?: string;
            aria-details?: string;
            aria-disabled?: Booleanish;
            aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup";
            aria-errormessage?: string;
            aria-expanded?: Booleanish;
            aria-flowto?: string;
            aria-grabbed?: Booleanish;
            aria-haspopup?: boolean | "false" | "grid" | "dialog" | "menu" | "listbox" | "true" | "tree";
            aria-hidden?: Booleanish;
            aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling";
            aria-keyshortcuts?: string;
            aria-label?: string;
            aria-labelledby?: string;
            aria-level?: number;
            aria-live?: "off" | "assertive" | "polite";
            aria-modal?: Booleanish;
            aria-multiline?: Booleanish;
            aria-multiselectable?: Booleanish;
            aria-orientation?: "horizontal" | "vertical";
            aria-owns?: string;
            aria-placeholder?: string;
            aria-posinset?: number;
            aria-pressed?: boolean | "false" | "mixed" | "true";
            aria-readonly?: Booleanish;
            aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
            aria-required?: Booleanish;
            aria-roledescription?: string;
            aria-rowcount?: number;
            aria-rowindex?: number;
            aria-rowindextext?: string;
            aria-rowspan?: number;
            aria-selected?: Booleanish;
            aria-setsize?: number;
            aria-sort?: "none" | "other" | "ascending" | "descending";
            aria-valuemax?: number;
            aria-valuemin?: number;
            aria-valuenow?: number;
            aria-valuetext?: string;
            asChild?: boolean;
            autoCapitalize?: string;
            autoCorrect?: string;
            autoFocus?: boolean;
            autoSave?: string;
            children?: ReactNode;
            className?: string;
            color?: string;
            content?: string;
            contentEditable?: "inherit" | Booleanish | "plaintext-only";
            contextMenu?: string;
            dangerouslySetInnerHTML?: {
                __html: string | TrustedHTML;
            };
            datatype?: string;
            defaultChecked?: boolean;
            defaultValue?: string | number | readonly string[];
            dir?: string;
            disabled?: boolean;
            draggable?: Booleanish;
            form?: string;
            formAction?: string;
            formEncType?: string;
            formMethod?: string;
            formNoValidate?: boolean;
            formTarget?: string;
            hidden?: boolean;
            id?: string;
            inlist?: any;
            inputMode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal";
            is?: string;
            itemID?: string;
            itemProp?: string;
            itemRef?: string;
            itemScope?: boolean;
            itemType?: string;
            lang?: string;
            name?: string;
            nonce?: string;
            onAbort?: ReactEventHandler<HTMLButtonElement>;
            onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
            onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
            onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
            onAuxClick?: MouseEventHandler<HTMLButtonElement>;
            onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
            onBeforeInput?: FormEventHandler<HTMLButtonElement>;
            onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
            onBlur?: FocusEventHandler<HTMLButtonElement>;
            onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
            onCanPlay?: ReactEventHandler<HTMLButtonElement>;
            onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
            onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
            onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
            onChange?: FormEventHandler<HTMLButtonElement>;
            onChangeCapture?: FormEventHandler<HTMLButtonElement>;
            onClick?: MouseEventHandler<HTMLButtonElement>;
            onClickCapture?: MouseEventHandler<HTMLButtonElement>;
            onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
            onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
            onContextMenu?: MouseEventHandler<HTMLButtonElement>;
            onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
            onCopy?: ClipboardEventHandler<HTMLButtonElement>;
            onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
            onCut?: ClipboardEventHandler<HTMLButtonElement>;
            onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
            onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
            onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
            onDrag?: DragEventHandler<HTMLButtonElement>;
            onDragCapture?: DragEventHandler<HTMLButtonElement>;
            onDragEnd?: DragEventHandler<HTMLButtonElement>;
            onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
            onDragEnter?: DragEventHandler<HTMLButtonElement>;
            onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
            onDragExit?: DragEventHandler<HTMLButtonElement>;
            onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
            onDragLeave?: DragEventHandler<HTMLButtonElement>;
            onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
            onDragOver?: DragEventHandler<HTMLButtonElement>;
            onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
            onDragStart?: DragEventHandler<HTMLButtonElement>;
            onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
            onDrop?: DragEventHandler<HTMLButtonElement>;
            onDropCapture?: DragEventHandler<HTMLButtonElement>;
            onDurationChange?: ReactEventHandler<HTMLButtonElement>;
            onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
            onEmptied?: ReactEventHandler<HTMLButtonElement>;
            onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
            onEncrypted?: ReactEventHandler<HTMLButtonElement>;
            onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
            onEnded?: ReactEventHandler<HTMLButtonElement>;
            onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
            onError?: ReactEventHandler<HTMLButtonElement>;
            onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
            onFocus?: FocusEventHandler<HTMLButtonElement>;
            onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
            onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
            onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
            onInput?: FormEventHandler<HTMLButtonElement>;
            onInputCapture?: FormEventHandler<HTMLButtonElement>;
            onInvalid?: FormEventHandler<HTMLButtonElement>;
            onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
            onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
            onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
            onLoad?: ReactEventHandler<HTMLButtonElement>;
            onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
            onLoadStart?: ReactEventHandler<HTMLButtonElement>;
            onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
            onLoadedData?: ReactEventHandler<HTMLButtonElement>;
            onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
            onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
            onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
            onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
            onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
            onMouseDown?: MouseEventHandler<HTMLButtonElement>;
            onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
            onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
            onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
            onMouseMove?: MouseEventHandler<HTMLButtonElement>;
            onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
            onMouseOut?: MouseEventHandler<HTMLButtonElement>;
            onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
            onMouseOver?: MouseEventHandler<HTMLButtonElement>;
            onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
            onMouseUp?: MouseEventHandler<HTMLButtonElement>;
            onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
            onPaste?: ClipboardEventHandler<HTMLButtonElement>;
            onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
            onPause?: ReactEventHandler<HTMLButtonElement>;
            onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
            onPlay?: ReactEventHandler<HTMLButtonElement>;
            onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
            onPlaying?: ReactEventHandler<HTMLButtonElement>;
            onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
            onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
            onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerDown?: PointerEventHandler<HTMLButtonElement>;
            onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
            onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
            onPointerMove?: PointerEventHandler<HTMLButtonElement>;
            onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerOut?: PointerEventHandler<HTMLButtonElement>;
            onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerOver?: PointerEventHandler<HTMLButtonElement>;
            onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
            onPointerUp?: PointerEventHandler<HTMLButtonElement>;
            onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
            onProgress?: ReactEventHandler<HTMLButtonElement>;
            onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
            onRateChange?: ReactEventHandler<HTMLButtonElement>;
            onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
            onReset?: FormEventHandler<HTMLButtonElement>;
            onResetCapture?: FormEventHandler<HTMLButtonElement>;
            onResize?: ReactEventHandler<HTMLButtonElement>;
            onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
            onScroll?: UIEventHandler<HTMLButtonElement>;
            onScrollCapture?: UIEventHandler<HTMLButtonElement>;
            onSeeked?: ReactEventHandler<HTMLButtonElement>;
            onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
            onSeeking?: ReactEventHandler<HTMLButtonElement>;
            onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
            onSelect?: ReactEventHandler<HTMLButtonElement>;
            onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
            onStalled?: ReactEventHandler<HTMLButtonElement>;
            onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
            onSubmit?: FormEventHandler<HTMLButtonElement>;
            onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
            onSuspend?: ReactEventHandler<HTMLButtonElement>;
            onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
            onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
            onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
            onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
            onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
            onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
            onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
            onTouchMove?: TouchEventHandler<HTMLButtonElement>;
            onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
            onTouchStart?: TouchEventHandler<HTMLButtonElement>;
            onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
            onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
            onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
            onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
            onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
            onWaiting?: ReactEventHandler<HTMLButtonElement>;
            onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
            onWheel?: WheelEventHandler<HTMLButtonElement>;
            onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
            prefix?: string;
            property?: string;
            radioGroup?: string;
            rel?: string;
            resource?: string;
            results?: number;
            rev?: string;
            role?: AriaRole;
            security?: string;
            size?: null | "default" | "icon" | "sm" | "lg";
            slot?: string;
            spellCheck?: Booleanish;
            style?: CSSProperties;
            suppressContentEditableWarning?: boolean;
            suppressHydrationWarning?: boolean;
            tabIndex?: number;
            title?: string;
            translate?: "yes" | "no";
            type?: "button" | "reset" | "submit";
            typeof?: string;
            unselectable?: "off" | "on";
            value?: string | number | readonly string[];
            variant?: null | "link" | "default" | "outline" | "destructive" | "secondary" | "ghost";
            vocab?: string;
        }

        Hierarchy

        • ButtonHTMLAttributes<HTMLButtonElement>
        • VariantProps<typeof buttonVariants>
          • ButtonProps

        Properties

        about? accessKey? aria-activedescendant? aria-atomic? @@ -388,8 +388,8 @@

        Optional aria-valuenow

        aria-valuenow?: number

        Defines the current value for a range widget.

        See

        aria-valuetext.

        Optional aria-valuetext

        aria-valuetext?: string

        Defines the human readable text alternative of aria-valuenow for a range widget.

        -

        Optional asChild

        asChild?: boolean

        Optional autoCapitalize

        autoCapitalize?: string

        Optional autoCorrect

        autoCorrect?: string

        Optional autoFocus

        autoFocus?: boolean

        Optional autoSave

        autoSave?: string

        Optional children

        children?: ReactNode

        Optional className

        className?: string

        Optional color

        color?: string

        Optional content

        content?: string

        Optional contentEditable

        contentEditable?: "inherit" | Booleanish | "plaintext-only"

        Optional contextMenu

        contextMenu?: string

        Optional dangerouslySetInnerHTML

        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        }

        Type declaration

        • __html: string | TrustedHTML

        Optional datatype

        datatype?: string

        Optional defaultChecked

        defaultChecked?: boolean

        Optional defaultValue

        defaultValue?: string | number | readonly string[]

        Optional dir

        dir?: string

        Optional disabled

        disabled?: boolean

        Optional draggable

        draggable?: Booleanish

        Optional form

        form?: string

        Optional formAction

        formAction?: string

        Optional formEncType

        formEncType?: string

        Optional formMethod

        formMethod?: string

        Optional formNoValidate

        formNoValidate?: boolean

        Optional formTarget

        formTarget?: string

        Optional hidden

        hidden?: boolean

        Optional id

        id?: string

        Optional inlist

        inlist?: any

        Optional inputMode

        inputMode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal"

        Hints at the type of data that might be entered by the user while editing the element or its contents

        +

        Optional asChild

        asChild?: boolean

        Optional autoCapitalize

        autoCapitalize?: string

        Optional autoCorrect

        autoCorrect?: string

        Optional autoFocus

        autoFocus?: boolean

        Optional autoSave

        autoSave?: string

        Optional children

        children?: ReactNode

        Optional className

        className?: string

        Optional color

        color?: string

        Optional content

        content?: string

        Optional contentEditable

        contentEditable?: "inherit" | Booleanish | "plaintext-only"

        Optional contextMenu

        contextMenu?: string

        Optional dangerouslySetInnerHTML

        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        }

        Type declaration

        • __html: string | TrustedHTML

        Optional datatype

        datatype?: string

        Optional defaultChecked

        defaultChecked?: boolean

        Optional defaultValue

        defaultValue?: string | number | readonly string[]

        Optional dir

        dir?: string

        Optional disabled

        disabled?: boolean

        Optional draggable

        draggable?: Booleanish

        Optional form

        form?: string

        Optional formAction

        formAction?: string

        Optional formEncType

        formEncType?: string

        Optional formMethod

        formMethod?: string

        Optional formNoValidate

        formNoValidate?: boolean

        Optional formTarget

        formTarget?: string

        Optional hidden

        hidden?: boolean

        Optional id

        id?: string

        Optional inlist

        inlist?: any

        Optional inputMode

        inputMode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal"

        Hints at the type of data that might be entered by the user while editing the element or its contents

        See

        https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

        Optional is

        is?: string

        Specify that a standard HTML element should behave like a defined custom built-in element

        See

        https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

        -

        Optional itemID

        itemID?: string

        Optional itemProp

        itemProp?: string

        Optional itemRef

        itemRef?: string

        Optional itemScope

        itemScope?: boolean

        Optional itemType

        itemType?: string

        Optional lang

        lang?: string

        Optional name

        name?: string

        Optional nonce

        nonce?: string

        Optional onAbort

        onAbort?: ReactEventHandler<HTMLButtonElement>

        Optional onAbortCapture

        onAbortCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onAnimationEnd

        onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationEndCapture

        onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationIteration

        onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationIterationCapture

        onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationStart

        onAnimationStart?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationStartCapture

        onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>

        Optional onAuxClick

        onAuxClick?: MouseEventHandler<HTMLButtonElement>

        Optional onAuxClickCapture

        onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onBeforeInput

        onBeforeInput?: FormEventHandler<HTMLButtonElement>

        Optional onBeforeInputCapture

        onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>

        Optional onBlur

        onBlur?: FocusEventHandler<HTMLButtonElement>

        Optional onBlurCapture

        onBlurCapture?: FocusEventHandler<HTMLButtonElement>

        Optional onCanPlay

        onCanPlay?: ReactEventHandler<HTMLButtonElement>

        Optional onCanPlayCapture

        onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onCanPlayThrough

        onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>

        Optional onCanPlayThroughCapture

        onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onChange

        onChange?: FormEventHandler<HTMLButtonElement>

        Optional onChangeCapture

        onChangeCapture?: FormEventHandler<HTMLButtonElement>

        Optional onClick

        onClick?: MouseEventHandler<HTMLButtonElement>

        Optional onClickCapture

        onClickCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onCompositionEnd

        onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionEndCapture

        onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionStart

        onCompositionStart?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionStartCapture

        onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionUpdate

        onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionUpdateCapture

        onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>

        Optional onContextMenu

        onContextMenu?: MouseEventHandler<HTMLButtonElement>

        Optional onContextMenuCapture

        onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onCopy

        onCopy?: ClipboardEventHandler<HTMLButtonElement>

        Optional onCopyCapture

        onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>

        Optional onCut

        onCut?: ClipboardEventHandler<HTMLButtonElement>

        Optional onCutCapture

        onCutCapture?: ClipboardEventHandler<HTMLButtonElement>

        Optional onDoubleClick

        onDoubleClick?: MouseEventHandler<HTMLButtonElement>

        Optional onDoubleClickCapture

        onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onDrag

        onDrag?: DragEventHandler<HTMLButtonElement>

        Optional onDragCapture

        onDragCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragEnd

        onDragEnd?: DragEventHandler<HTMLButtonElement>

        Optional onDragEndCapture

        onDragEndCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragEnter

        onDragEnter?: DragEventHandler<HTMLButtonElement>

        Optional onDragEnterCapture

        onDragEnterCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragExit

        onDragExit?: DragEventHandler<HTMLButtonElement>

        Optional onDragExitCapture

        onDragExitCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragLeave

        onDragLeave?: DragEventHandler<HTMLButtonElement>

        Optional onDragLeaveCapture

        onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragOver

        onDragOver?: DragEventHandler<HTMLButtonElement>

        Optional onDragOverCapture

        onDragOverCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragStart

        onDragStart?: DragEventHandler<HTMLButtonElement>

        Optional onDragStartCapture

        onDragStartCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDrop

        onDrop?: DragEventHandler<HTMLButtonElement>

        Optional onDropCapture

        onDropCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDurationChange

        onDurationChange?: ReactEventHandler<HTMLButtonElement>

        Optional onDurationChangeCapture

        onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onEmptied

        onEmptied?: ReactEventHandler<HTMLButtonElement>

        Optional onEmptiedCapture

        onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onEncrypted

        onEncrypted?: ReactEventHandler<HTMLButtonElement>

        Optional onEncryptedCapture

        onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onEnded

        onEnded?: ReactEventHandler<HTMLButtonElement>

        Optional onEndedCapture

        onEndedCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onError

        onError?: ReactEventHandler<HTMLButtonElement>

        Optional onErrorCapture

        onErrorCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onFocus

        onFocus?: FocusEventHandler<HTMLButtonElement>

        Optional onFocusCapture

        onFocusCapture?: FocusEventHandler<HTMLButtonElement>

        Optional onGotPointerCapture

        onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onGotPointerCaptureCapture

        onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onInput

        onInput?: FormEventHandler<HTMLButtonElement>

        Optional onInputCapture

        onInputCapture?: FormEventHandler<HTMLButtonElement>

        Optional onInvalid

        onInvalid?: FormEventHandler<HTMLButtonElement>

        Optional onInvalidCapture

        onInvalidCapture?: FormEventHandler<HTMLButtonElement>

        Optional onKeyDown

        onKeyDown?: KeyboardEventHandler<HTMLButtonElement>

        Optional onKeyDownCapture

        onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>

        Optional onKeyPress

        onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

        Deprecated

        Optional onKeyPressCapture

        onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

        Deprecated

        Optional onKeyUp

        onKeyUp?: KeyboardEventHandler<HTMLButtonElement>

        Optional onKeyUpCapture

        onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>

        Optional onLoad

        onLoad?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadCapture

        onLoadCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadStart

        onLoadStart?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadStartCapture

        onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadedData

        onLoadedData?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadedDataCapture

        onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadedMetadata

        onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadedMetadataCapture

        onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onLostPointerCapture

        onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onLostPointerCaptureCapture

        onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onMouseDown

        onMouseDown?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseDownCapture

        onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseEnter

        onMouseEnter?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseLeave

        onMouseLeave?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseMove

        onMouseMove?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseMoveCapture

        onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseOut

        onMouseOut?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseOutCapture

        onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseOver

        onMouseOver?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseOverCapture

        onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseUp

        onMouseUp?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseUpCapture

        onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onPaste

        onPaste?: ClipboardEventHandler<HTMLButtonElement>

        Optional onPasteCapture

        onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>

        Optional onPause

        onPause?: ReactEventHandler<HTMLButtonElement>

        Optional onPauseCapture

        onPauseCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onPlay

        onPlay?: ReactEventHandler<HTMLButtonElement>

        Optional onPlayCapture

        onPlayCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onPlaying

        onPlaying?: ReactEventHandler<HTMLButtonElement>

        Optional onPlayingCapture

        onPlayingCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onPointerCancel

        onPointerCancel?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerCancelCapture

        onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerDown

        onPointerDown?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerDownCapture

        onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerEnter

        onPointerEnter?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerLeave

        onPointerLeave?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerMove

        onPointerMove?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerMoveCapture

        onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerOut

        onPointerOut?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerOutCapture

        onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerOver

        onPointerOver?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerOverCapture

        onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerUp

        onPointerUp?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerUpCapture

        onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onProgress

        onProgress?: ReactEventHandler<HTMLButtonElement>

        Optional onProgressCapture

        onProgressCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onRateChange

        onRateChange?: ReactEventHandler<HTMLButtonElement>

        Optional onRateChangeCapture

        onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onReset

        onReset?: FormEventHandler<HTMLButtonElement>

        Optional onResetCapture

        onResetCapture?: FormEventHandler<HTMLButtonElement>

        Optional onResize

        onResize?: ReactEventHandler<HTMLButtonElement>

        Optional onResizeCapture

        onResizeCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onScroll

        onScroll?: UIEventHandler<HTMLButtonElement>

        Optional onScrollCapture

        onScrollCapture?: UIEventHandler<HTMLButtonElement>

        Optional onSeeked

        onSeeked?: ReactEventHandler<HTMLButtonElement>

        Optional onSeekedCapture

        onSeekedCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onSeeking

        onSeeking?: ReactEventHandler<HTMLButtonElement>

        Optional onSeekingCapture

        onSeekingCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onSelect

        onSelect?: ReactEventHandler<HTMLButtonElement>

        Optional onSelectCapture

        onSelectCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onStalled

        onStalled?: ReactEventHandler<HTMLButtonElement>

        Optional onStalledCapture

        onStalledCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onSubmit

        onSubmit?: FormEventHandler<HTMLButtonElement>

        Optional onSubmitCapture

        onSubmitCapture?: FormEventHandler<HTMLButtonElement>

        Optional onSuspend

        onSuspend?: ReactEventHandler<HTMLButtonElement>

        Optional onSuspendCapture

        onSuspendCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onTimeUpdate

        onTimeUpdate?: ReactEventHandler<HTMLButtonElement>

        Optional onTimeUpdateCapture

        onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onTouchCancel

        onTouchCancel?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchCancelCapture

        onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchEnd

        onTouchEnd?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchEndCapture

        onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchMove

        onTouchMove?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchMoveCapture

        onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchStart

        onTouchStart?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchStartCapture

        onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

        Optional onTransitionEnd

        onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

        Optional onTransitionEndCapture

        onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

        Optional onVolumeChange

        onVolumeChange?: ReactEventHandler<HTMLButtonElement>

        Optional onVolumeChangeCapture

        onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onWaiting

        onWaiting?: ReactEventHandler<HTMLButtonElement>

        Optional onWaitingCapture

        onWaitingCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onWheel

        onWheel?: WheelEventHandler<HTMLButtonElement>

        Optional onWheelCapture

        onWheelCapture?: WheelEventHandler<HTMLButtonElement>

        Optional prefix

        prefix?: string

        Optional property

        property?: string

        Optional radioGroup

        radioGroup?: string

        Optional rel

        rel?: string

        Optional resource

        resource?: string

        Optional results

        results?: number

        Optional rev

        rev?: string

        Optional role

        role?: AriaRole

        Optional security

        security?: string

        Optional size

        size?: null | "default" | "icon" | "sm" | "lg" = ...

        Optional slot

        slot?: string

        Optional spellCheck

        spellCheck?: Booleanish

        Optional style

        style?: CSSProperties

        Optional suppressContentEditableWarning

        suppressContentEditableWarning?: boolean

        Optional suppressHydrationWarning

        suppressHydrationWarning?: boolean

        Optional tabIndex

        tabIndex?: number

        Optional title

        title?: string

        Optional translate

        translate?: "yes" | "no"

        Optional type

        type?: "button" | "reset" | "submit"

        Optional typeof

        typeof?: string

        Optional unselectable

        unselectable?: "off" | "on"

        Optional value

        value?: string | number | readonly string[]

        Optional variant

        variant?: null | "link" | "default" | "outline" | "destructive" | "secondary" | "ghost" = ...

        Optional vocab

        vocab?: string

        Settings

        Member Visibility

        Theme

        On This Page

        aboutaccessKeyaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasChildautoCapitalizeautoCorrectautoFocusautoSavechildrenclassNamecolorcontentcontentEditablecontextMenudangerouslySetInnerHTMLdatatypedefaultCheckeddefaultValuedirdisableddraggableformformActionformEncTypeformMethodformNoValidateformTargethiddenidinlistinputModeisitemIDitemPropitemRefitemScopeitemTypelangnamenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadStartonLoadStartCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureprefixpropertyradioGrouprelresourceresultsrevrolesecuritysizeslotspellCheckstylesuppressContentEditableWarningsuppressHydrationWarningtabIndextitletranslatetypetypeofunselectablevaluevariantvocab
        \ No newline at end of file +

        Optional itemID

        itemID?: string

        Optional itemProp

        itemProp?: string

        Optional itemRef

        itemRef?: string

        Optional itemScope

        itemScope?: boolean

        Optional itemType

        itemType?: string

        Optional lang

        lang?: string

        Optional name

        name?: string

        Optional nonce

        nonce?: string

        Optional onAbort

        onAbort?: ReactEventHandler<HTMLButtonElement>

        Optional onAbortCapture

        onAbortCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onAnimationEnd

        onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationEndCapture

        onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationIteration

        onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationIterationCapture

        onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationStart

        onAnimationStart?: AnimationEventHandler<HTMLButtonElement>

        Optional onAnimationStartCapture

        onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>

        Optional onAuxClick

        onAuxClick?: MouseEventHandler<HTMLButtonElement>

        Optional onAuxClickCapture

        onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onBeforeInput

        onBeforeInput?: FormEventHandler<HTMLButtonElement>

        Optional onBeforeInputCapture

        onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>

        Optional onBlur

        onBlur?: FocusEventHandler<HTMLButtonElement>

        Optional onBlurCapture

        onBlurCapture?: FocusEventHandler<HTMLButtonElement>

        Optional onCanPlay

        onCanPlay?: ReactEventHandler<HTMLButtonElement>

        Optional onCanPlayCapture

        onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onCanPlayThrough

        onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>

        Optional onCanPlayThroughCapture

        onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onChange

        onChange?: FormEventHandler<HTMLButtonElement>

        Optional onChangeCapture

        onChangeCapture?: FormEventHandler<HTMLButtonElement>

        Optional onClick

        onClick?: MouseEventHandler<HTMLButtonElement>

        Optional onClickCapture

        onClickCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onCompositionEnd

        onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionEndCapture

        onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionStart

        onCompositionStart?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionStartCapture

        onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionUpdate

        onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>

        Optional onCompositionUpdateCapture

        onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>

        Optional onContextMenu

        onContextMenu?: MouseEventHandler<HTMLButtonElement>

        Optional onContextMenuCapture

        onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onCopy

        onCopy?: ClipboardEventHandler<HTMLButtonElement>

        Optional onCopyCapture

        onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>

        Optional onCut

        onCut?: ClipboardEventHandler<HTMLButtonElement>

        Optional onCutCapture

        onCutCapture?: ClipboardEventHandler<HTMLButtonElement>

        Optional onDoubleClick

        onDoubleClick?: MouseEventHandler<HTMLButtonElement>

        Optional onDoubleClickCapture

        onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onDrag

        onDrag?: DragEventHandler<HTMLButtonElement>

        Optional onDragCapture

        onDragCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragEnd

        onDragEnd?: DragEventHandler<HTMLButtonElement>

        Optional onDragEndCapture

        onDragEndCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragEnter

        onDragEnter?: DragEventHandler<HTMLButtonElement>

        Optional onDragEnterCapture

        onDragEnterCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragExit

        onDragExit?: DragEventHandler<HTMLButtonElement>

        Optional onDragExitCapture

        onDragExitCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragLeave

        onDragLeave?: DragEventHandler<HTMLButtonElement>

        Optional onDragLeaveCapture

        onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragOver

        onDragOver?: DragEventHandler<HTMLButtonElement>

        Optional onDragOverCapture

        onDragOverCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDragStart

        onDragStart?: DragEventHandler<HTMLButtonElement>

        Optional onDragStartCapture

        onDragStartCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDrop

        onDrop?: DragEventHandler<HTMLButtonElement>

        Optional onDropCapture

        onDropCapture?: DragEventHandler<HTMLButtonElement>

        Optional onDurationChange

        onDurationChange?: ReactEventHandler<HTMLButtonElement>

        Optional onDurationChangeCapture

        onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onEmptied

        onEmptied?: ReactEventHandler<HTMLButtonElement>

        Optional onEmptiedCapture

        onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onEncrypted

        onEncrypted?: ReactEventHandler<HTMLButtonElement>

        Optional onEncryptedCapture

        onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onEnded

        onEnded?: ReactEventHandler<HTMLButtonElement>

        Optional onEndedCapture

        onEndedCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onError

        onError?: ReactEventHandler<HTMLButtonElement>

        Optional onErrorCapture

        onErrorCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onFocus

        onFocus?: FocusEventHandler<HTMLButtonElement>

        Optional onFocusCapture

        onFocusCapture?: FocusEventHandler<HTMLButtonElement>

        Optional onGotPointerCapture

        onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onGotPointerCaptureCapture

        onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onInput

        onInput?: FormEventHandler<HTMLButtonElement>

        Optional onInputCapture

        onInputCapture?: FormEventHandler<HTMLButtonElement>

        Optional onInvalid

        onInvalid?: FormEventHandler<HTMLButtonElement>

        Optional onInvalidCapture

        onInvalidCapture?: FormEventHandler<HTMLButtonElement>

        Optional onKeyDown

        onKeyDown?: KeyboardEventHandler<HTMLButtonElement>

        Optional onKeyDownCapture

        onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>

        Optional onKeyPress

        onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

        Deprecated

        Optional onKeyPressCapture

        onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

        Deprecated

        Optional onKeyUp

        onKeyUp?: KeyboardEventHandler<HTMLButtonElement>

        Optional onKeyUpCapture

        onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>

        Optional onLoad

        onLoad?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadCapture

        onLoadCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadStart

        onLoadStart?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadStartCapture

        onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadedData

        onLoadedData?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadedDataCapture

        onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadedMetadata

        onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>

        Optional onLoadedMetadataCapture

        onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onLostPointerCapture

        onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onLostPointerCaptureCapture

        onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onMouseDown

        onMouseDown?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseDownCapture

        onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseEnter

        onMouseEnter?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseLeave

        onMouseLeave?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseMove

        onMouseMove?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseMoveCapture

        onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseOut

        onMouseOut?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseOutCapture

        onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseOver

        onMouseOver?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseOverCapture

        onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseUp

        onMouseUp?: MouseEventHandler<HTMLButtonElement>

        Optional onMouseUpCapture

        onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

        Optional onPaste

        onPaste?: ClipboardEventHandler<HTMLButtonElement>

        Optional onPasteCapture

        onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>

        Optional onPause

        onPause?: ReactEventHandler<HTMLButtonElement>

        Optional onPauseCapture

        onPauseCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onPlay

        onPlay?: ReactEventHandler<HTMLButtonElement>

        Optional onPlayCapture

        onPlayCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onPlaying

        onPlaying?: ReactEventHandler<HTMLButtonElement>

        Optional onPlayingCapture

        onPlayingCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onPointerCancel

        onPointerCancel?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerCancelCapture

        onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerDown

        onPointerDown?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerDownCapture

        onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerEnter

        onPointerEnter?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerLeave

        onPointerLeave?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerMove

        onPointerMove?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerMoveCapture

        onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerOut

        onPointerOut?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerOutCapture

        onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerOver

        onPointerOver?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerOverCapture

        onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerUp

        onPointerUp?: PointerEventHandler<HTMLButtonElement>

        Optional onPointerUpCapture

        onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

        Optional onProgress

        onProgress?: ReactEventHandler<HTMLButtonElement>

        Optional onProgressCapture

        onProgressCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onRateChange

        onRateChange?: ReactEventHandler<HTMLButtonElement>

        Optional onRateChangeCapture

        onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onReset

        onReset?: FormEventHandler<HTMLButtonElement>

        Optional onResetCapture

        onResetCapture?: FormEventHandler<HTMLButtonElement>

        Optional onResize

        onResize?: ReactEventHandler<HTMLButtonElement>

        Optional onResizeCapture

        onResizeCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onScroll

        onScroll?: UIEventHandler<HTMLButtonElement>

        Optional onScrollCapture

        onScrollCapture?: UIEventHandler<HTMLButtonElement>

        Optional onSeeked

        onSeeked?: ReactEventHandler<HTMLButtonElement>

        Optional onSeekedCapture

        onSeekedCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onSeeking

        onSeeking?: ReactEventHandler<HTMLButtonElement>

        Optional onSeekingCapture

        onSeekingCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onSelect

        onSelect?: ReactEventHandler<HTMLButtonElement>

        Optional onSelectCapture

        onSelectCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onStalled

        onStalled?: ReactEventHandler<HTMLButtonElement>

        Optional onStalledCapture

        onStalledCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onSubmit

        onSubmit?: FormEventHandler<HTMLButtonElement>

        Optional onSubmitCapture

        onSubmitCapture?: FormEventHandler<HTMLButtonElement>

        Optional onSuspend

        onSuspend?: ReactEventHandler<HTMLButtonElement>

        Optional onSuspendCapture

        onSuspendCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onTimeUpdate

        onTimeUpdate?: ReactEventHandler<HTMLButtonElement>

        Optional onTimeUpdateCapture

        onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onTouchCancel

        onTouchCancel?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchCancelCapture

        onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchEnd

        onTouchEnd?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchEndCapture

        onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchMove

        onTouchMove?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchMoveCapture

        onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchStart

        onTouchStart?: TouchEventHandler<HTMLButtonElement>

        Optional onTouchStartCapture

        onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

        Optional onTransitionEnd

        onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

        Optional onTransitionEndCapture

        onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

        Optional onVolumeChange

        onVolumeChange?: ReactEventHandler<HTMLButtonElement>

        Optional onVolumeChangeCapture

        onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onWaiting

        onWaiting?: ReactEventHandler<HTMLButtonElement>

        Optional onWaitingCapture

        onWaitingCapture?: ReactEventHandler<HTMLButtonElement>

        Optional onWheel

        onWheel?: WheelEventHandler<HTMLButtonElement>

        Optional onWheelCapture

        onWheelCapture?: WheelEventHandler<HTMLButtonElement>

        Optional prefix

        prefix?: string

        Optional property

        property?: string

        Optional radioGroup

        radioGroup?: string

        Optional rel

        rel?: string

        Optional resource

        resource?: string

        Optional results

        results?: number

        Optional rev

        rev?: string

        Optional role

        role?: AriaRole

        Optional security

        security?: string

        Optional size

        size?: null | "default" | "icon" | "sm" | "lg" = ...

        Optional slot

        slot?: string

        Optional spellCheck

        spellCheck?: Booleanish

        Optional style

        style?: CSSProperties

        Optional suppressContentEditableWarning

        suppressContentEditableWarning?: boolean

        Optional suppressHydrationWarning

        suppressHydrationWarning?: boolean

        Optional tabIndex

        tabIndex?: number

        Optional title

        title?: string

        Optional translate

        translate?: "yes" | "no"

        Optional type

        type?: "button" | "reset" | "submit"

        Optional typeof

        typeof?: string

        Optional unselectable

        unselectable?: "off" | "on"

        Optional value

        value?: string | number | readonly string[]

        Optional variant

        variant?: null | "link" | "default" | "outline" | "destructive" | "secondary" | "ghost" = ...

        Optional vocab

        vocab?: string

        Settings

        Member Visibility

        Theme

        On This Page

        aboutaccessKeyaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasChildautoCapitalizeautoCorrectautoFocusautoSavechildrenclassNamecolorcontentcontentEditablecontextMenudangerouslySetInnerHTMLdatatypedefaultCheckeddefaultValuedirdisableddraggableformformActionformEncTypeformMethodformNoValidateformTargethiddenidinlistinputModeisitemIDitemPropitemRefitemScopeitemTypelangnamenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadStartonLoadStartCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureprefixpropertyradioGrouprelresourceresultsrevrolesecuritysizeslotspellCheckstylesuppressContentEditableWarningsuppressHydrationWarningtabIndextitletranslatetypetypeofunselectablevaluevariantvocab
        \ No newline at end of file diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index 14bc8e8a99..1b1cd0875d 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)

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +CommandHandler | platform-bible-react

        Interface CommandHandler

        interface CommandHandler ((command) => void)

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index 45a434d01b..42c151bb1b 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;
            })[];
        }>)
        • 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;
              })[];
          }>

        Settings

        Member Visibility

        Theme

        \ 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;
            })[];
        }>)
        • 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;
              })[];
          }>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/AnchorOrigin.html b/platform-bible-react/types/AnchorOrigin.html index fafbda4670..b1877331d5 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +AnchorOrigin | platform-bible-react

        Type alias AnchorOrigin

        AnchorOrigin: SnackbarOrigin

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 5476fa3953..3e1c186914 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;
            handleSelectEndChapter: ((chapter) => void);
            handleSelectStartChapter: ((chapter) => void);
            isDisabled?: boolean;
        }

        Type declaration

        • chapterCount: number
        • handleSelectEndChapter: ((chapter) => void)
            • (chapter): void

            • Parameters

              • chapter: number

              Returns void

        • handleSelectStartChapter: ((chapter) => void)
            • (chapter): void

            • Parameters

              • chapter: number

              Returns void

        • Optional isDisabled?: boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ChapterRangeSelectorProps | platform-bible-react

        Type alias ChapterRangeSelectorProps

        ChapterRangeSelectorProps: {
            chapterCount: number;
            handleSelectEndChapter: ((chapter) => void);
            handleSelectStartChapter: ((chapter) => void);
            isDisabled?: boolean;
        }

        Type declaration

        • chapterCount: number
        • handleSelectEndChapter: ((chapter) => void)
            • (chapter): void

            • Parameters

              • chapter: number

              Returns void

        • handleSelectStartChapter: ((chapter) => void)
            • (chapter): void

            • Parameters

              • chapter: number

              Returns void

        • Optional isDisabled?: boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/CheckboxProps.html b/platform-bible-react/types/CheckboxProps.html index 4012ae4df7..099765ff02 100644 --- a/platform-bible-react/types/CheckboxProps.html +++ b/platform-bible-react/types/CheckboxProps.html @@ -21,4 +21,4 @@
          • (event): void

          • Parameters

            • event: ChangeEvent<HTMLInputElement>

              The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).

              -

            Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ChecklistProps.html b/platform-bible-react/types/ChecklistProps.html index 3ef9ffd98c..1bb4afa35e 100644 --- a/platform-bible-react/types/ChecklistProps.html +++ b/platform-bible-react/types/ChecklistProps.html @@ -6,4 +6,4 @@
      • Optional legend?: string

        Optional string representing legend for fieldset element

      • listItems: string[]

        Array of strings representing the legend text for the fieldset element

      • selectedListItems: string[]

        Array of strings representing items to be displayed as checkboxes in the checklist

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/CloseReason.html b/platform-bible-react/types/CloseReason.html index 8e0bdd5c83..ac28bc4b3d 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +CloseReason | platform-bible-react

        Type alias CloseReason

        CloseReason: SnackbarCloseReason

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ColumnDef.html b/platform-bible-react/types/ColumnDef.html index 8b0a03f96e..a5f5b8d77b 100644 --- a/platform-bible-react/types/ColumnDef.html +++ b/platform-bible-react/types/ColumnDef.html @@ -1 +1 @@ -ColumnDef | platform-bible-react

        Type alias ColumnDef<TData, TValue>

        ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

        Type Parameters

        • TData
        • TValue = unknown

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ColumnDef | platform-bible-react

        Type alias ColumnDef<TData, TValue>

        ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

        Type Parameters

        • TData
        • TValue = unknown

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index fec4fa0d92..06a35ebddc 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ComboBoxLabelOption | platform-bible-react

        Type alias ComboBoxLabelOption

        ComboBoxLabelOption: {
            label: string;
        }

        Type declaration

        • label: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index 64549005d6..45fc26017c 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react

        Type alias ComboBoxOption

        ComboBoxOption: string | number | ComboBoxLabelOption

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ComboBoxOption | platform-bible-react

        Type alias ComboBoxOption

        ComboBoxOption: string | number | ComboBoxLabelOption

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index d22e522f1b..2b5537bf9c 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -10,4 +10,4 @@
      • Optional textPlaceholder?: string

        Placeholder text for text field

      • Optional value?: T

        The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownGroup.html b/platform-bible-react/types/DropdownGroup.html index feacdc200a..48c441530f 100644 --- a/platform-bible-react/types/DropdownGroup.html +++ b/platform-bible-react/types/DropdownGroup.html @@ -1,4 +1,4 @@ DropdownGroup | platform-bible-react

        Type alias DropdownGroup

        DropdownGroup: {
            items: DropdownItem[];
            label: string;
        }

        Type declaration

        • items: DropdownItem[]

          The items array contains the items that will be displayed in the dropdown group

        • label: string

          The label is the text that will be displayed on the dropdown group. It is used to categorize the items in the group.

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownItem.html b/platform-bible-react/types/DropdownItem.html index 978f1ba8f5..e825d0b228 100644 --- a/platform-bible-react/types/DropdownItem.html +++ b/platform-bible-react/types/DropdownItem.html @@ -1,4 +1,4 @@ DropdownItem | platform-bible-react

        Type alias DropdownItem

        DropdownItem: {
            itemType: DropdownMenuItemType;
            label: string;
            onClick: (() => void);
        }

        Type declaration

        • itemType: DropdownMenuItemType

          The itemType determines the DropdownMenuItemType type as either Check or Radio.

        • label: string

          The label is the text that will be displayed on the dropdown item.

        • onClick: (() => void)

          The onClick function is called when the item is clicked.

          -
            • (): void

            • Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
          • (): void

          • Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html index be4b8c747c..b4594810b1 100644 --- a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html +++ b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html @@ -1 +1 @@ -DropdownMenuCheckboxItemProps | platform-bible-react

        Type alias DropdownMenuCheckboxItemProps

        DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
            checked?: boolean;
            className?: string;
        }

        Type declaration

        • Optional checked?: boolean
        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuCheckboxItemProps | platform-bible-react

        Type alias DropdownMenuCheckboxItemProps

        DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
            checked?: boolean;
            className?: string;
        }

        Type declaration

        • Optional checked?: boolean
        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuContentProps.html b/platform-bible-react/types/DropdownMenuContentProps.html index a5c4bdb49d..f2461d6925 100644 --- a/platform-bible-react/types/DropdownMenuContentProps.html +++ b/platform-bible-react/types/DropdownMenuContentProps.html @@ -1 +1 @@ -DropdownMenuContentProps | platform-bible-react

        Type alias DropdownMenuContentProps

        DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
            className?: string;
            sideOffset?: number;
        }

        Type declaration

        • Optional className?: string
        • Optional sideOffset?: number

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuContentProps | platform-bible-react

        Type alias DropdownMenuContentProps

        DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
            className?: string;
            sideOffset?: number;
        }

        Type declaration

        • Optional className?: string
        • Optional sideOffset?: number

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuItemProps.html b/platform-bible-react/types/DropdownMenuItemProps.html index 000346f2a7..c4090e49ff 100644 --- a/platform-bible-react/types/DropdownMenuItemProps.html +++ b/platform-bible-react/types/DropdownMenuItemProps.html @@ -1 +1 @@ -DropdownMenuItemProps | platform-bible-react

        Type alias DropdownMenuItemProps

        DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
            className?: string;
            inset?: boolean;
        }

        Type declaration

        • Optional className?: string
        • Optional inset?: boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuItemProps | platform-bible-react

        Type alias DropdownMenuItemProps

        DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
            className?: string;
            inset?: boolean;
        }

        Type declaration

        • Optional className?: string
        • Optional inset?: boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuLabelProps.html b/platform-bible-react/types/DropdownMenuLabelProps.html index 3d21016511..7f106a86f6 100644 --- a/platform-bible-react/types/DropdownMenuLabelProps.html +++ b/platform-bible-react/types/DropdownMenuLabelProps.html @@ -1 +1 @@ -DropdownMenuLabelProps | platform-bible-react

        Type alias DropdownMenuLabelProps

        DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
            className?: string;
            inset?: boolean;
        }

        Type declaration

        • Optional className?: string
        • Optional inset?: boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuLabelProps | platform-bible-react

        Type alias DropdownMenuLabelProps

        DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
            className?: string;
            inset?: boolean;
        }

        Type declaration

        • Optional className?: string
        • Optional inset?: boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuRadioItemProps.html b/platform-bible-react/types/DropdownMenuRadioItemProps.html index 5cdd889cb4..f0078a0d54 100644 --- a/platform-bible-react/types/DropdownMenuRadioItemProps.html +++ b/platform-bible-react/types/DropdownMenuRadioItemProps.html @@ -1 +1 @@ -DropdownMenuRadioItemProps | platform-bible-react

        Type alias DropdownMenuRadioItemProps

        DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
            className?: string;
        }

        Type declaration

        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuRadioItemProps | platform-bible-react

        Type alias DropdownMenuRadioItemProps

        DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
            className?: string;
        }

        Type declaration

        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSeparatorProps.html b/platform-bible-react/types/DropdownMenuSeparatorProps.html index cc559941dc..10b7510e3c 100644 --- a/platform-bible-react/types/DropdownMenuSeparatorProps.html +++ b/platform-bible-react/types/DropdownMenuSeparatorProps.html @@ -1 +1 @@ -DropdownMenuSeparatorProps | platform-bible-react

        Type alias DropdownMenuSeparatorProps

        DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
            className?: string;
        }

        Type declaration

        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuSeparatorProps | platform-bible-react

        Type alias DropdownMenuSeparatorProps

        DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
            className?: string;
        }

        Type declaration

        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuShortcutProps.html b/platform-bible-react/types/DropdownMenuShortcutProps.html index 7f441ef07b..04e418c6ba 100644 --- a/platform-bible-react/types/DropdownMenuShortcutProps.html +++ b/platform-bible-react/types/DropdownMenuShortcutProps.html @@ -1 +1 @@ -DropdownMenuShortcutProps | platform-bible-react

        Type alias DropdownMenuShortcutProps

        DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
            className?: string;
        }

        Type declaration

        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuShortcutProps | platform-bible-react

        Type alias DropdownMenuShortcutProps

        DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
            className?: string;
        }

        Type declaration

        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSubContentProps.html b/platform-bible-react/types/DropdownMenuSubContentProps.html index a5e0b459d6..8135eee6e1 100644 --- a/platform-bible-react/types/DropdownMenuSubContentProps.html +++ b/platform-bible-react/types/DropdownMenuSubContentProps.html @@ -1 +1 @@ -DropdownMenuSubContentProps | platform-bible-react

        Type alias DropdownMenuSubContentProps

        DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
            className?: string;
        }

        Type declaration

        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuSubContentProps | platform-bible-react

        Type alias DropdownMenuSubContentProps

        DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
            className?: string;
        }

        Type declaration

        • Optional className?: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSubTriggerProps.html b/platform-bible-react/types/DropdownMenuSubTriggerProps.html index 5a44594774..293a18336c 100644 --- a/platform-bible-react/types/DropdownMenuSubTriggerProps.html +++ b/platform-bible-react/types/DropdownMenuSubTriggerProps.html @@ -1 +1 @@ -DropdownMenuSubTriggerProps | platform-bible-react

        Type alias DropdownMenuSubTriggerProps

        DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
            className?: string;
            inset?: boolean;
        }

        Type declaration

        • Optional className?: string
        • Optional inset?: boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +DropdownMenuSubTriggerProps | platform-bible-react

        Type alias DropdownMenuSubTriggerProps

        DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
            className?: string;
            inset?: boolean;
        }

        Type declaration

        • Optional className?: string
        • Optional inset?: boolean

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index b099aae49e..3cf0954d55 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.

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index 04403efdb6..471c1f0532 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index 702adc2acf..dc1b80d67e 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.

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/InventoryLocalizedStrings.html b/platform-bible-react/types/InventoryLocalizedStrings.html index e577770766..b978a7f918 100644 --- a/platform-bible-react/types/InventoryLocalizedStrings.html +++ b/platform-bible-react/types/InventoryLocalizedStrings.html @@ -1 +1 @@ -InventoryLocalizedStrings | platform-bible-react

        Type alias InventoryLocalizedStrings

        InventoryLocalizedStrings: {
            [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
        }

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +InventoryLocalizedStrings | platform-bible-react

        Type alias InventoryLocalizedStrings

        InventoryLocalizedStrings: {
            [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
        }

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ItemData.html b/platform-bible-react/types/ItemData.html index 77c36fdfe4..3d3fc1733c 100644 --- a/platform-bible-react/types/ItemData.html +++ b/platform-bible-react/types/ItemData.html @@ -1 +1 @@ -ItemData | platform-bible-react

        Type alias ItemData

        ItemData: {
            count: number;
            item: string;
            status: Status;
        }

        Type declaration

        • count: number
        • item: string
        • status: Status

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +ItemData | platform-bible-react

        Type alias ItemData

        ItemData: {
            count: number;
            item: string;
            status: Status;
        }

        Type declaration

        • count: number
        • item: string
        • status: Status

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index 9838c52221..c3f3cc8ce7 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ResultsSet.html b/platform-bible-react/types/ResultsSet.html index d41c2be04f..323514d0ef 100644 --- a/platform-bible-react/types/ResultsSet.html +++ b/platform-bible-react/types/ResultsSet.html @@ -3,4 +3,4 @@ sources.

        Type declaration

        • data: ScriptureItemDetail[]

          Array of Scripture item details (messages keyed by Scripture reference).

        • source: ResultsSource

          The backing source associated with this set of results.

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ResultsSource.html b/platform-bible-react/types/ResultsSource.html index 5b65c52a3b..631d5787f5 100644 --- a/platform-bible-react/types/ResultsSource.html +++ b/platform-bible-react/types/ResultsSource.html @@ -3,4 +3,4 @@ sources.

        Type declaration

        • displayName: string

          Name (potentially localized) of the source, suitable for display in the UI.

        • id: string

          Uniquely identifies the source.

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/RowContents.html b/platform-bible-react/types/RowContents.html index ceed0d9316..851edb5dfd 100644 --- a/platform-bible-react/types/RowContents.html +++ b/platform-bible-react/types/RowContents.html @@ -1 +1 @@ -RowContents | platform-bible-react

        Type alias RowContents<TData>

        RowContents<TData>: TSRow<TData>

        Type Parameters

        • TData

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +RowContents | platform-bible-react

        Type alias RowContents<TData>

        RowContents<TData>: TSRow<TData>

        Type Parameters

        • TData

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ScriptureItemDetail.html b/platform-bible-react/types/ScriptureItemDetail.html index 19889faa12..26ec4647cb 100644 --- a/platform-bible-react/types/ScriptureItemDetail.html +++ b/platform-bible-react/types/ScriptureItemDetail.html @@ -3,4 +3,4 @@

        Type declaration

        • detail: string

          Text of the error, note, etc. In the future, we might want to support something more than just text so that a JSX element could be provided with a link or some other controls related to the issue being reported.

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html index b0238a8b38..542e10d9f8 100644 --- a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html +++ b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html @@ -2,4 +2,4 @@
      • Optional scriptureBookGroupName?: string

        Optional text to display to refer to the Scripture book group. Default value: 'Scripture Book'.

      • Optional scriptureReferenceColumnName?: string

        Optional header to display for the Reference column. Default value: 'Scripture Reference'.

      • Optional typeColumnName?: string

        Optional header to display for the Type column. Default value: 'Type'.

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ScriptureResultsViewerProps.html b/platform-bible-react/types/ScriptureResultsViewerProps.html index 7bd271af71..4880044315 100644 --- a/platform-bible-react/types/ScriptureResultsViewerProps.html +++ b/platform-bible-react/types/ScriptureResultsViewerProps.html @@ -3,4 +3,4 @@
      • Optional showColumnHeaders?: boolean

        Flag indicating whether to display column headers. Default is false.

      • Optional showSourceColumn?: boolean

        Flag indicating whether to display source column. Default is false.

      • sources: ResultsSet[]

        Groups of ScriptureItemDetail objects from particular sources (e.g., Scripture checks)

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ScriptureSrcItemDetail.html b/platform-bible-react/types/ScriptureSrcItemDetail.html index 0bb1a820d5..f7f963bdca 100644 --- a/platform-bible-react/types/ScriptureSrcItemDetail.html +++ b/platform-bible-react/types/ScriptureSrcItemDetail.html @@ -1,2 +1,2 @@ ScriptureSrcItemDetail | platform-bible-react

        Type alias ScriptureSrcItemDetail

        ScriptureSrcItemDetail: ScriptureItemDetail & {
            source: ResultsSource;
        }

        Type declaration

        • source: ResultsSource

          Source/type of detail. Can be used for grouping.

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index 119b46b896..838c75e25c 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -1,4 +1,4 @@ SearchBarProps | platform-bible-react

        Type alias SearchBarProps

        SearchBarProps: {
            isFullWidth?: boolean;
            onSearch: ((searchQuery) => void);
            placeholder?: string;
        }

        Type declaration

        • Optional isFullWidth?: boolean

          Optional boolean to set the input base to full width

        • onSearch: ((searchQuery) => void)

          Callback fired to handle the search query when button pressed

            • (searchQuery): void

            • Parameters

              • searchQuery: string

              Returns void

        • Optional placeholder?: string

          Optional string that appears in the search bar without a search string

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SliderProps.html b/platform-bible-react/types/SliderProps.html index 39e28fcf9b..57a2def2e0 100644 --- a/platform-bible-react/types/SliderProps.html +++ b/platform-bible-react/types/SliderProps.html @@ -40,4 +40,4 @@

        Default

        'off'
        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarContentProps.html b/platform-bible-react/types/SnackbarContentProps.html index 8b9a0fbe15..d86e087d01 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarProps.html b/platform-bible-react/types/SnackbarProps.html index 6b8000862a..4d1f14e1de 100644 --- a/platform-bible-react/types/SnackbarProps.html +++ b/platform-bible-react/types/SnackbarProps.html @@ -12,4 +12,4 @@
      • Optional onClose?: ((event, reason) => void)

        Optional, used to control the open prop event: Event | SyntheticEvent<Element, Event>, reason: string

        -
          • (event, reason): void

          • Parameters

            • event: Event | SyntheticEvent<Element, Event>
            • reason: CloseReason

            Returns void

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +
          • (event, reason): void

          • Parameters

            • event: Event | SyntheticEvent<Element, Event>
            • reason: CloseReason

            Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SortDirection.html b/platform-bible-react/types/SortDirection.html index 961e0a946f..8d62a93d8c 100644 --- a/platform-bible-react/types/SortDirection.html +++ b/platform-bible-react/types/SortDirection.html @@ -1 +1 @@ -SortDirection | platform-bible-react

        Type alias SortDirection

        SortDirection: TSSortDirection

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +SortDirection | platform-bible-react

        Type alias SortDirection

        SortDirection: TSSortDirection

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/Status.html b/platform-bible-react/types/Status.html index f8924e5786..e1f7fbda2d 100644 --- a/platform-bible-react/types/Status.html +++ b/platform-bible-react/types/Status.html @@ -1 +1 @@ -Status | platform-bible-react

        Type alias Status

        Status: "approved" | "unapproved" | "unknown"

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +Status | platform-bible-react

        Type alias Status

        Status: "approved" | "unapproved" | "unknown"

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/SwitchProps.html b/platform-bible-react/types/SwitchProps.html index 465f9022dd..e51851c422 100644 --- a/platform-bible-react/types/SwitchProps.html +++ b/platform-bible-react/types/SwitchProps.html @@ -11,4 +11,4 @@
          • (event): void

          • Parameters

            • event: ChangeEvent<HTMLInputElement>

              The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).

              -

            Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TableContents.html b/platform-bible-react/types/TableContents.html index 287aac17af..5214793350 100644 --- a/platform-bible-react/types/TableContents.html +++ b/platform-bible-react/types/TableContents.html @@ -1 +1 @@ -TableContents | platform-bible-react

        Type alias TableContents<TData>

        TableContents<TData>: TSTable<TData>

        Type Parameters

        • TData

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +TableContents | platform-bible-react

        Type alias TableContents<TData>

        TableContents<TData>: TSTable<TData>

        Type Parameters

        • TData

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index 30d4c0262a..06c4a5b9bd 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -20,4 +20,4 @@
      • Optional onFocus?: FocusEventHandler<HTMLInputElement>

        Triggers when textfield gets focus

      • Optional placeholder?: string

        The short hint displayed in the input before the user enters a value.

      • Optional value?: string | number

        Value of the text field if controlled

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index 7196818c0c..4a7f428d93 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.

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index 2d996f4872..0e5ae2bc83 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/VersionHistoryType.html b/platform-bible-react/types/VersionHistoryType.html index b178c34618..b7d8c3bc33 100644 --- a/platform-bible-react/types/VersionHistoryType.html +++ b/platform-bible-react/types/VersionHistoryType.html @@ -1,2 +1,2 @@ VersionHistoryType | platform-bible-react

        Type alias VersionHistoryType

        VersionHistoryType: Record<string, VersionInformation>

        Type to store the version history information

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/types/VersionInformation.html b/platform-bible-react/types/VersionInformation.html index 1f51b61163..531e84b58e 100644 --- a/platform-bible-react/types/VersionInformation.html +++ b/platform-bible-react/types/VersionInformation.html @@ -1,3 +1,3 @@ VersionInformation | platform-bible-react

        Type alias VersionInformation

        VersionInformation: {
            date: string;
            description: string;
        }

        Type declaration

        • date: string

          Date the version was published

        • description: string

          Description of the changes in the version

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html index 4ab5b8b157..cc0a65dc95 100644 --- a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html +++ b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html @@ -1 +1 @@ -INVENTORY_STRING_KEYS | platform-bible-react

        Variable INVENTORY_STRING_KEYSConst

        INVENTORY_STRING_KEYS: readonly ["%webView_inventory_all%", "%webView_inventory_approved%", "%webView_inventory_unapproved%", "%webView_inventory_unknown%", "%webView_inventory_scope_book%", "%webView_inventory_scope_chapter%", "%webView_inventory_scope_verse%", "%webView_inventory_filter_text%", "%webView_inventory_occurrences_table_header_reference%", "%webView_inventory_occurrences_table_header_occurrence%"] = ...

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +INVENTORY_STRING_KEYS | platform-bible-react

        Variable INVENTORY_STRING_KEYSConst

        INVENTORY_STRING_KEYS: readonly ["%webView_inventory_all%", "%webView_inventory_approved%", "%webView_inventory_unapproved%", "%webView_inventory_unknown%", "%webView_inventory_scope_book%", "%webView_inventory_scope_chapter%", "%webView_inventory_scope_verse%", "%webView_inventory_filter_text%", "%webView_inventory_occurrences_table_header_reference%", "%webView_inventory_occurrences_table_header_occurrence%"] = ...

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index e768c6041b..a9a9484fed 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

        constructor +

        Type Parameters

        • T

        Constructors

        constructor

        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. Defaults to 10000 ms

        -

        • Returns AsyncVariable<T>

        Properties

        Private Readonly promiseToValue

        promiseToValue: Promise<T>

        Private rejecter

        rejecter: undefined | ((reason) => void)

        Type declaration

          • (reason): void

          • Parameters

            • reason: undefined | string

            Returns void

        Private resolver

        resolver: undefined | ((value) => void)

        Type declaration

          • (value): void

          • Parameters

            • value: T

            Returns void

        Private Readonly variableName

        variableName: string

        Accessors

        hasSettled

        • get hasSettled(): boolean

        • A simple way to see if this variable's promise was resolved or rejected already

          +

        Returns AsyncVariable<T>

        Properties

        Private Readonly promiseToValue

        promiseToValue: Promise<T>

        Private rejecter

        rejecter: undefined | ((reason) => void)

        Type declaration

          • (reason): void

          • Parameters

            • reason: undefined | string

            Returns void

        Private resolver

        resolver: undefined | ((value) => void)

        Type declaration

          • (value): void

          • Parameters

            • value: T

            Returns void

        Private Readonly variableName

        variableName: string

        Accessors

        hasSettled

        promise

        promise

        • 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

        Private complete

        rejectWithReason

        Methods

        Private complete

        rejectWithReason

        • rejectWithReason(reason, throwIfAlreadySettled?): void

        • 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. Defaults to false

            -

          Returns void

        resolveToValue

        • resolveToValue(value, throwIfAlreadySettled?): void

        • Resolve this variable's promise to the given value

          +

        Returns void

        resolveToValue

        • resolveToValue(value, throwIfAlreadySettled?): 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. Defaults to false

            -

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorpromiseToValuerejecterresolvervariableNamehasSettledpromisecompleterejectWithReasonresolveToValue
        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorpromiseToValuerejecterresolvervariableNamehasSettledpromisecompleterejectWithReasonresolveToValue
        \ No newline at end of file diff --git a/platform-bible-utils/classes/Collator.html b/platform-bible-utils/classes/Collator.html index b4f2ac4110..6b766f8532 100644 --- a/platform-bible-utils/classes/Collator.html +++ b/platform-bible-utils/classes/Collator.html @@ -1,15 +1,15 @@ Collator | platform-bible-utils

        Class Collator

        Enables language-sensitive string comparison. Wraps Intl.Collator

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        collator

        Methods

        compare resolvedOptions -

        Constructors

        constructor

        Properties

        Private collator

        collator: Collator

        Methods

        compare

        • compare(string1, string2): number

        • Compares two strings according to the sort order of this Collator object

          +

        Constructors

        constructor

        Properties

        Private collator

        collator: Collator

        Methods

        compare

        • compare(string1, string2): number

        • Compares two strings according to the sort order of this Collator object

          Parameters

          • string1: string

            String to compare

          • string2: string

            String to compare

          Returns number

          A number indicating how string1 and string2 compare to each other according to the sort order of this Collator object. Negative value if string1 comes before string2. Positive value if string1 comes after string2. 0 if they are considered equal.

          -

        resolvedOptions

        resolvedOptions

        • resolvedOptions(): ResolvedCollatorOptions

        • Returns a new object with properties reflecting the locale and collation options computed during initialization of this collator object.

          Returns ResolvedCollatorOptions

          ResolvedCollatorOptions object

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorcollatorcompareresolvedOptions
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        constructorcollatorcompareresolvedOptions
        \ No newline at end of file diff --git a/platform-bible-utils/classes/DateTimeFormat.html b/platform-bible-utils/classes/DateTimeFormat.html index bf036ccdde..eeb16d1fdb 100644 --- a/platform-bible-utils/classes/DateTimeFormat.html +++ b/platform-bible-utils/classes/DateTimeFormat.html @@ -1,30 +1,30 @@ DateTimeFormat | platform-bible-utils

        Class DateTimeFormat

        Enables language-sensitive data and time formatting. Wraps Intl.DateTimeFormat

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        dateTimeFormatter

        Methods

        format formatRange formatRangeToParts formatToParts resolvedOptions -

        Constructors

        constructor

        Properties

        Private dateTimeFormatter

        dateTimeFormatter: DateTimeFormat

        Methods

        format

        • format(date): string

        • Formats a date according to the locale and formatting option for this DateTimeFormat object

          +

        Constructors

        constructor

        Properties

        Private dateTimeFormatter

        dateTimeFormatter: DateTimeFormat

        Methods

        format

        • format(date): string

        • Formats a date according to the locale and formatting option for this DateTimeFormat object

          Parameters

          • date: Date

            The date to format

          Returns string

          String representing the given date formatted according to the locale and formatting options of this DateTimeFormat object

          -

        formatRange

        formatRange

        • formatRange(startDate, endDate): string

        • Formats a date range in the most concise way based on the locales and options provided when instantiating this DateTimeFormat object

          Parameters

          • startDate: Date

            Date object representing start of the date range

          • endDate: Date

            Date object representing the end of the date range

          Returns string

          String representing the given date range formatted according to the locale and formatting options of this DateTimeFormat object

          -

        formatRangeToParts

        formatRangeToParts

        • formatRangeToParts(startDate, endDate): DateTimeRangeFormatPart[]

        • Returns an array of locale-specific tokens representing each part of the formatted date range produced by this DateTimeFormat object

          Parameters

          • startDate: Date

            Date object representing start of the date range

          • endDate: Date

            Date object representing the end of the date range

          Returns DateTimeRangeFormatPart[]

          Array of DateTimeRangeFormatPart objects

          -

        formatToParts

        formatToParts

        • formatToParts(date): DateTimeFormatPart[]

        • Allows locale-aware formatting of strings produced by this DateTimeFormat object

          Parameters

          • date: Date

            The date to format

          Returns DateTimeFormatPart[]

          Array of DateTimeFormatPart objects

          -

        resolvedOptions

        resolvedOptions

        • resolvedOptions(): ResolvedDateTimeFormatOptions

        • Returns a new object with properties reflecting the locale and date and time formatting options computed during initialization of this DateTimeFormat object

          Returns ResolvedDateTimeFormatOptions

          ResolvedDateTimeFormatOptions object

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructordateTimeFormatterformatformatRangeformatRangeToPartsformatToPartsresolvedOptions
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        constructordateTimeFormatterformatformatRangeformatRangeToPartsformatToPartsresolvedOptions
        \ No newline at end of file diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index 797e0c656f..edb780e314 100644 --- a/platform-bible-utils/classes/DocumentCombiner.html +++ b/platform-bible-utils/classes/DocumentCombiner.html @@ -1,6 +1,6 @@ DocumentCombiner | platform-bible-utils

        Class DocumentCombiner

        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

        constructor +

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        baseDocument contributions latestOutput @@ -21,8 +21,8 @@

        Constructors

        Protected constructor

        Properties

        Protected baseDocument

        baseDocument: JsonDocumentLike

        Protected Readonly contributions

        contributions: Map<string, JsonDocumentLike> = ...

        Protected latestOutput

        latestOutput: undefined | JsonDocumentLike

        Readonly onDidRebuild

        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        -

        Private Readonly onDidRebuildEmitter

        onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

        Protected Readonly options

        options: DocumentCombinerOptions

        Methods

        addOrUpdateContribution

        • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

        • Add or update one of the contribution documents for the composition process

          +

        Returns DocumentCombiner

        Properties

        Protected baseDocument

        baseDocument: JsonDocumentLike

        Protected Readonly contributions

        contributions: Map<string, JsonDocumentLike> = ...

        Protected latestOutput

        latestOutput: undefined | JsonDocumentLike

        Readonly onDidRebuild

        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        +

        Private Readonly onDidRebuildEmitter

        onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

        Protected Readonly options

        options: DocumentCombinerOptions

        Methods

        addOrUpdateContribution

        • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

        • 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

        -

        deleteAllContributions

        deleteAllContributions

        deleteContribution

        deleteContribution

        rebuild

        rebuild

        Protected transformBaseDocumentAfterValidation

        Protected transformBaseDocumentAfterValidation

        • transformBaseDocumentAfterValidation(baseDocument): JsonDocumentLike

        • 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

          -

        Protected transformContributionAfterValidation

        Protected transformContributionAfterValidation

        • transformContributionAfterValidation(documentName, document): JsonDocumentLike

        • 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

        -

        Protected transformFinalOutputBeforeValidation

        Protected transformFinalOutputBeforeValidation

        • transformFinalOutputBeforeValidation(finalOutput): JsonDocumentLike

        • Transform the document that is the composition of the base document and all contribution documents. This is the last step that will be run prior to validation via validateOutput before this.latestOutput is updated to the new output.

          Parameters

          • finalOutput: JsonDocumentLike

            Final output document that could potentially be returned to callers. "Final" means no further contribution documents will be merged.

            -

          Returns JsonDocumentLike

        updateBaseDocument

        • updateBaseDocument(baseDocument): undefined | JsonDocumentLike

        • Update the starting document for composition process

          +

        Returns JsonDocumentLike

        updateBaseDocument

        Protected validateBaseDocument

        Protected validateBaseDocument

        Protected validateContribution

        • validateContribution(documentName, document): void

        • Throw an error if the provided document is not a valid contribution document.

          +

        Returns void

        Protected validateContribution

        • validateContribution(documentName, document): void

        • Throw an error if the provided document is not a valid contribution document.

          Parameters

          • documentName: string

            Name of the contributed document to combine

          • document: JsonDocumentLike

            Content of the contributed document to combine

            -

          Returns void

        Protected validateOutput

        • validateOutput(output): void

        • Throw an error if the provided output is not valid.

          +

        Returns void

        Protected validateOutput

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbaseDocumentcontributionslatestOutputonDidRebuildonDidRebuildEmitteroptionsaddOrUpdateContributiondeleteAllContributionsdeleteContributionrebuildtransformBaseDocumentAfterValidationtransformContributionAfterValidationtransformFinalOutputBeforeValidationupdateBaseDocumentvalidateBaseDocumentvalidateContributionvalidateOutput
        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbaseDocumentcontributionslatestOutputonDidRebuildonDidRebuildEmitteroptionsaddOrUpdateContributiondeleteAllContributionsdeleteContributionrebuildtransformBaseDocumentAfterValidationtransformContributionAfterValidationtransformFinalOutputBeforeValidationupdateBaseDocumentvalidateBaseDocumentvalidateContributionvalidateOutput
        \ No newline at end of file diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index cb654858a9..80c4842034 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

        • Mutex
          • Mutex

        Constructors

        constructor +

        Hierarchy

        • Mutex
          • Mutex

        Constructors

        constructor

        Methods

        acquire cancel isLocked diff --git a/platform-bible-utils/classes/MutexMap.html b/platform-bible-utils/classes/MutexMap.html index 38d9e8ad5c..bb15548dd5 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,5 +1,5 @@ MutexMap | platform-bible-utils

        Class MutexMap

        Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        mutexesByID

        Methods

        get -

        Constructors

        constructor

        Properties

        Private mutexesByID

        mutexesByID: Map<string, Mutex> = ...

        Methods

        get

        Settings

        Member Visibility

        Theme

        On This Page

        constructormutexesByIDget
        \ No newline at end of file +

        Constructors

        constructor

        Properties

        Private mutexesByID

        mutexesByID: Map<string, Mutex> = ...

        Methods

        get

        Settings

        Member Visibility

        Theme

        On This Page

        constructormutexesByIDget
        \ No newline at end of file diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index 0e65ba4ded..e1dc70ef76 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

        constructor +

        Hierarchy (view full)

        Constructors

        constructor

        Properties

        baseDocument contributions latestOutput @@ -18,8 +18,8 @@ validateBaseDocument validateContribution validateOutput -

        Constructors

        constructor

        Properties

        Protected baseDocument

        baseDocument: JsonDocumentLike

        Protected Readonly contributions

        contributions: Map<string, JsonDocumentLike> = ...

        Protected latestOutput

        latestOutput: undefined | JsonDocumentLike

        Readonly onDidRebuild

        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        -

        Protected Readonly options

        options: DocumentCombinerOptions

        Accessors

        output

        Methods

        addOrUpdateContribution

        • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

        • Add or update one of the contribution documents for the composition process

          +

        Constructors

        constructor

        Properties

        Protected baseDocument

        baseDocument: JsonDocumentLike

        Protected Readonly contributions

        contributions: Map<string, JsonDocumentLike> = ...

        Protected latestOutput

        latestOutput: undefined | JsonDocumentLike

        Readonly onDidRebuild

        onDidRebuild: PlatformEvent<undefined> = ...

        Event that emits to announce that the document has been rebuilt and the output has been updated

        +

        Protected Readonly options

        options: DocumentCombinerOptions

        Accessors

        output

        Methods

        addOrUpdateContribution

        • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

        • 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

        -

        deleteAllContributions

        deleteAllContributions

        deleteContribution

        deleteContribution

        rebuild

        rebuild

        Protected transformBaseDocumentAfterValidation

        Protected transformBaseDocumentAfterValidation

        Protected transformContributionAfterValidation

        Protected transformContributionAfterValidation

        • transformContributionAfterValidation(documentName, document): JsonDocumentLike

        • 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

        -

        Protected transformFinalOutputBeforeValidation

        Protected transformFinalOutputBeforeValidation

        updateBaseDocument

        • updateBaseDocument(baseDocument): undefined | JsonDocumentLike

        • Update the starting document for composition process

          +

        Returns JsonDocumentLike

        updateBaseDocument

        Protected validateBaseDocument

        Protected validateBaseDocument

        Protected validateContribution

        • validateContribution(documentName, document): void

        • Throw an error if the provided document is not a valid contribution document.

          +

        Returns void

        Protected validateContribution

        Protected validateOutput

        • validateOutput(output): void

        • Throw an error if the provided output is not valid.

          +

        Returns void

        Protected validateOutput

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbaseDocumentcontributionslatestOutputonDidRebuildoptionsoutputaddOrUpdateContributiondeleteAllContributionsdeleteContributionrebuildtransformBaseDocumentAfterValidationtransformContributionAfterValidationtransformFinalOutputBeforeValidationupdateBaseDocumentvalidateBaseDocumentvalidateContributionvalidateOutput
        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorbaseDocumentcontributionslatestOutputonDidRebuildoptionsoutputaddOrUpdateContributiondeleteAllContributionsdeleteContributionrebuildtransformBaseDocumentAfterValidationtransformContributionAfterValidationtransformFinalOutputBeforeValidationupdateBaseDocumentvalidateBaseDocumentvalidateContributionvalidateOutput
        \ No newline at end of file diff --git a/platform-bible-utils/classes/NumberFormat.html b/platform-bible-utils/classes/NumberFormat.html index 60b817d8ae..b7a5977c8a 100644 --- a/platform-bible-utils/classes/NumberFormat.html +++ b/platform-bible-utils/classes/NumberFormat.html @@ -1,31 +1,31 @@ NumberFormat | platform-bible-utils

        Class NumberFormat

        Enables language-sensitive number formatting. Wraps Intl.NumberFormat

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        numberFormatter

        Methods

        format formatRange formatRangeToParts formatToParts resolvedOptions -

        Constructors

        constructor

        Properties

        Private numberFormatter

        numberFormatter: NumberFormat

        Methods

        format

        • format(value): string

        • Formats a number according to the locale and formatting options of this NumberFormat object

          +

        Constructors

        constructor

        Properties

        Private numberFormatter

        numberFormatter: NumberFormat

        Methods

        format

        • format(value): string

        • Formats a number according to the locale and formatting options of this NumberFormat object

          Parameters

          • value: number | bigint

            Number or BigInt to format

          Returns string

          String representing the given number formatted according to the locale and formatting options of this NumberFormat object

          -

        formatRange

        formatRange

        • formatRange(startRange, endRange): string

        • Formats a range of numbers according to the locale and formatting options of this NumberFormat object

          Parameters

          • startRange: number | bigint

            Number or bigint representing the start of the range

          • endRange: number | bigint

            Number or bigint representing the end of the range

          Returns string

          String representing the given range of numbers formatted according to the locale and formatting options of this NumberFormat object

          -

        formatRangeToParts

        formatRangeToParts

        • formatRangeToParts(startRange, endRange): NumberRangeFormatPart[]

        • Returns an array of objects containing the locale-specific tokens from which it is possible to build custom strings while preserving the locale-specific parts.

          Parameters

          • startRange: number | bigint

            Number or bigint representing start of the range

          • endRange: number | bigint

            Number or bigint representing end of the range

          Returns NumberRangeFormatPart[]

          Array of NumberRangeFormatPart objects containing the formatted range of numbers in parts

          -

        formatToParts

        formatToParts

        • formatToParts(value): NumberFormatPart[]

        • Allows locale-aware formatting of strings produced by this NumberFormat object

          Parameters

          • value: number | bigint

            Number or bigint to format

          Returns NumberFormatPart[]

          Array of NumberFormatPart objects containing the formatted number in parts

          -

        resolvedOptions

        resolvedOptions

        • resolvedOptions(): ResolvedNumberFormatOptions

        • Returns a new object with properties reflecting the locale and number formatting options computed during initialization of this NumberFormat object

          Returns ResolvedNumberFormatOptions

          ResolvedNumberFormatOptions object

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructornumberFormatterformatformatRangeformatRangeToPartsformatToPartsresolvedOptions
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        constructornumberFormatterformatformatRangeformatRangeToPartsformatToPartsresolvedOptions
        \ No newline at end of file diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index e5bf2843aa..4d4364e50c 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

        • T

        Implements

        Constructors

        constructor +

        Type Parameters

        • T

        Implements

        Constructors

        constructor

        Properties

        isDisposed lazyEvent? subscribe @@ -15,23 +15,23 @@ emit emitFn

        Constructors

        constructor

        Properties

        Private isDisposed

        isDisposed: boolean = false

        Whether this emitter has been disposed

        -

        Private Optional lazyEvent

        lazyEvent?: PlatformEvent<T>

        Event for listeners to subscribe to. Lazy loaded

        -

        subscribe

        subscribe: PlatformEvent<T> = ...

        Subscribes a function to run when this event is emitted.

        +

        Private Optional lazyEvent

        lazyEvent?: PlatformEvent<T>

        Event for listeners to subscribe to. Lazy loaded

        +

        subscribe

        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

        -

        Private Optional subscriptions

        subscriptions?: PlatformEventHandler<T>[]

        All callback functions that will run when this event is emitted. Lazy loaded

        -

        Accessors

        event

        Private Optional subscriptions

        subscriptions?: PlatformEventHandler<T>[]

        All callback functions that will run when this event is emitted. Lazy loaded

        +

        Accessors

        event

        Methods

        Protected assertNotDisposed

        dispose

        Protected disposeFn

        Methods

        Protected assertNotDisposed

        dispose

        Protected disposeFn

        emit

        emit

        Protected emitFn

        • emitFn(event): void

        • Function that runs the subscriptions for the event. Added here so children can override emit +

        Returns void

        Protected emitFn

        Settings

        Member Visibility

        Theme

        On This Page

        constructorisDisposedlazyEventsubscribesubscriptionseventassertNotDisposeddisposedisposeFnemitemitFn
        \ No newline at end of file +

        Parameters

        • event: T

        Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorisDisposedlazyEventsubscribesubscriptionseventassertNotDisposeddisposedisposeFnemitemitFn
        \ No newline at end of file diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index 0b081f57c2..2579a6b5f9 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,11 +1,11 @@ UnsubscriberAsyncList | platform-bible-utils

        Class UnsubscriberAsyncList

        Simple collection for UnsubscriberAsync objects that also provides an easy way to run them.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Properties

        name unsubscribers

        Methods

        add runAllUnsubscribers -

        Constructors

        constructor

        Properties

        Private name

        name: string = 'Anonymous'

        Readonly unsubscribers

        unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

        Methods

        add

        • add(...unsubscribers): void

        • Add unsubscribers to the list. Note that duplicates are not added twice.

          +

        Constructors

        constructor

        Properties

        Private name

        name: string = 'Anonymous'

        Readonly unsubscribers

        unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

        Methods

        add

        runAllUnsubscribers

        • runAllUnsubscribers(): Promise<boolean>

        • Run all unsubscribers added to this list and then clear the list.

          +

        Returns void

        runAllUnsubscribers

        Settings

        Member Visibility

        Theme

        On This Page

        constructornameunsubscribersaddrunAllUnsubscribers
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        constructornameunsubscribersaddrunAllUnsubscribers
        \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index 901506417b..7f134b8ecc 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index 2f4721bf28..ac357183de 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index 86dc88786c..8599d7e301 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index 5205674985..282e31a9d5 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index 2548df603a..0f0457abf5 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/compareScrRefs.html b/platform-bible-utils/functions/compareScrRefs.html index 519f980ab4..ce975293bd 100644 --- a/platform-bible-utils/functions/compareScrRefs.html +++ b/platform-bible-utils/functions/compareScrRefs.html @@ -4,4 +4,4 @@

        Returns number

        A number indicating the result of the comparison: - Negative value if scrRef1 precedes scrRef2 in sorting order. - Zero if scrRef1 and scrRef2 are equivalent in sorting order. - Positive value if scrRef1 follows scrRef2 in sorting order.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index 012143872b..15a78613c9 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index dbbbc9f0ab..3defc6a33f 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index b173e03c39..2e6e166ceb 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

        • T

        Parameters

        • obj: T

          Object to clone

        Returns T

        Duplicate copy of obj without any references back to the original one

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index e29692496d..3d840a634e 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index 6a6c20a4a8..603273a2b3 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.

        -
          • (this, key, value): unknown

          • Parameters

            • this: unknown
            • key: string
            • value: unknown

            Returns unknown

        Returns any

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
          • (this, key, value): unknown

          • Parameters

            • this: unknown
            • key: string
            • value: unknown

            Returns unknown

        Returns any

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index dfc1465a05..038dc77c37 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/escapeStringRegexp.html b/platform-bible-utils/functions/escapeStringRegexp.html index d4b5d7c02e..50541f0075 100644 --- a/platform-bible-utils/functions/escapeStringRegexp.html +++ b/platform-bible-utils/functions/escapeStringRegexp.html @@ -5,4 +5,4 @@ function is simply copied directly from there to allow a common js export

        Parameters

        • string: string

        Returns string

        Example

        import escapeStringRegexp from 'platform-bible-utils';

            const escapedString = escapeStringRegexp('How much $ for a 🦄?');
            //=> 'How much \\$ for a 🦄\\?'

            new RegExp(escapedString);
        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/formatBytes.html b/platform-bible-utils/functions/formatBytes.html index b104d061b2..d092c2c7d9 100644 --- a/platform-bible-utils/functions/formatBytes.html +++ b/platform-bible-utils/functions/formatBytes.html @@ -7,4 +7,4 @@

        Example

        FormatBytes(1024, 0) => "1 KB"
        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/formatReplacementString.html b/platform-bible-utils/functions/formatReplacementString.html index 368745bb95..30e734c275 100644 --- a/platform-bible-utils/functions/formatReplacementString.html +++ b/platform-bible-utils/functions/formatReplacementString.html @@ -7,4 +7,4 @@ 'name': 'Jim'}) would return 'I am Nemo'.

        Parameters

        Returns string

        Formatted string

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/formatScrRef.html b/platform-bible-utils/functions/formatScrRef.html index c420f091e0..f1f8a0ed63 100644 --- a/platform-bible-utils/functions/formatScrRef.html +++ b/platform-bible-utils/functions/formatScrRef.html @@ -9,4 +9,4 @@
      • Optional bookChapterSeparator: string

        The character used to separate the book from the chapter number. Default is a single space. Note: More than one character is allowed.

        • Returns string

        The formatted reference.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index 70866aa7bf..ebaa809e49 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index 9f5faa5b38..76ab802787 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getCurrentLocale.html b/platform-bible-utils/functions/getCurrentLocale.html index c83bee2bf9..21b75d1a74 100644 --- a/platform-bible-utils/functions/getCurrentLocale.html +++ b/platform-bible-utils/functions/getCurrentLocale.html @@ -1,4 +1,4 @@ getCurrentLocale | platform-bible-utils

        Function getCurrentLocale

        • getCurrentLocale(): string

        • Retrieves the current locale of the user's environment.

          Returns string

          A string representing the current locale. If the locale cannot be determined, the function returns an empty string.

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 77dc799944..cfaeb7a844 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)) }`
        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index 3ea13c9e66..9173a7896b 100644 --- a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html +++ b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html @@ -6,4 +6,4 @@

        Parameters

        Returns Promise<string>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns Promise<string>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index 1d037193ac..d35115bd61 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

        -
      • groupBy<T, K, V>(items, keySelector, valueSelector): Map<K, V[]>

      • 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[]>

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +
      • groupBy<T, K, V>(items, keySelector, valueSelector): Map<K, V[]>

      • 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[]>

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 41f1356490..962716f6ca 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils

        Function htmlEncode

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index db096ff5fd..10b99a7360 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index e7d27bf225..945b4e548b 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isLocalizeKey.html b/platform-bible-utils/functions/isLocalizeKey.html index f11f796a4b..dc7728fa39 100644 --- a/platform-bible-utils/functions/isLocalizeKey.html +++ b/platform-bible-utils/functions/isLocalizeKey.html @@ -1,2 +1,2 @@ isLocalizeKey | platform-bible-utils

        Function isLocalizeKey

        • isLocalizeKey(str): str is `%${string}%`

        • Determine whether the string is a LocalizeKey meant to be localized in Platform.Bible.

          -

          Parameters

          • str: string

          Returns str is `%${string}%`

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns str is `%${string}%`

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index e9412ed699..2bd9b71808 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index 1a9cfdf26d..e8c3d62ded 100644 --- a/platform-bible-utils/functions/isString.html +++ b/platform-bible-utils/functions/isString.html @@ -1,4 +1,4 @@ isString | platform-bible-utils

        Function isString

        • isString(o): o is string

        • 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isSubset.html b/platform-bible-utils/functions/isSubset.html index 831a93db50..2bdf927be5 100644 --- a/platform-bible-utils/functions/isSubset.html +++ b/platform-bible-utils/functions/isSubset.html @@ -13,4 +13,4 @@

        It is important to note that only arrays of primitives (i.e., booleans, numbers, strings) are supported. In particular, objects in arrays will not be checked for deep equality. Also, presence in an array is all this checks, not the number of times that an item appears in an array. [1, 1] is a subset of [1].

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index cf2f29253d..be5ffd28dd 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index d247896d6e..360f9dcf37 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils

        Function newGuid

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index 6acb60d023..0b3e80a5e5 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index 8090837516..bec796ac4c 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils

        Function offsetBook

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +offsetBook | platform-bible-utils

        Function offsetBook

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index 90ea0ddcd3..89938634f0 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

        Function offsetChapter

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +offsetChapter | platform-bible-utils

        Function offsetChapter

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index 45c5c4338f..3c66c0597b 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils

        Function offsetVerse

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +offsetVerse | platform-bible-utils

        Function offsetVerse

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/ordinalCompare.html b/platform-bible-utils/functions/ordinalCompare.html index 640d045bf4..321c7f8304 100644 --- a/platform-bible-utils/functions/ordinalCompare.html +++ b/platform-bible-utils/functions/ordinalCompare.html @@ -7,4 +7,4 @@

        Returns number

        A number indicating the result of the comparison: - Negative value if string1 precedes string2 in sorting order. - Zero if string1 and string2 are equivalent in sorting order. - Positive value if string1 follows string2 in sorting order.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index b7077d39f2..6441284805 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index 42662387ee..c5f177b1e5 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html index 4bbc03665a..8e3ca0c329 100644 --- a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html +++ b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html @@ -2,4 +2,4 @@

        Parameters

        Returns number

        An integer where the first three digits represent the book, the next three represent the chapter and the last three represent the verse.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 7604886572..3309d83f6e 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Returns string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index 6a0f2d617a..60a947a5d1 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index 47ea6d22db..da1cea9257 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index d4df2ec3ca..1a2ba84764 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index e4e1874246..aa249bed09 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index 501ce36f45..9a00c4af38 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index f1ba06652c..c58a305ce4 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 0484b7fdf5..97dac138e9 100644 --- a/platform-bible-utils/functions/wait.html +++ b/platform-bible-utils/functions/wait.html @@ -1,2 +1,2 @@ wait | platform-bible-utils

        Function wait

        • wait(ms): Promise<void>

        • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

          -

          Parameters

          • ms: number

          Returns Promise<void>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Parameters

        Returns Promise<void>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index dc6167b045..483d5127b0 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 3575a763c7..e5ead00f22 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

        interface BookInfo {
            chapters: number;
            fullNames: string[];
            shortName: string;
        }

        Properties

        chapters +BookInfo | platform-bible-utils

        Interface BookInfo

        interface BookInfo {
            chapters: number;
            fullNames: string[];
            shortName: string;
        }

        Properties

        chapters fullNames shortName -

        Properties

        chapters

        chapters: number

        fullNames

        fullNames: string[]

        shortName

        shortName: string

        Settings

        Member Visibility

        Theme

        On This Page

        chaptersfullNamesshortName
        \ No newline at end of file +

        Properties

        chapters

        chapters: number

        fullNames

        fullNames: string[]

        shortName

        shortName: string

        Settings

        Member Visibility

        Theme

        On This Page

        chaptersfullNamesshortName
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index ac4b1f185d..a2561fec5e 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

        dispose? +
        interface CannotHaveOnDidDispose {
            dispose?: UnsubscriberAsync;
            onDidDispose?: undefined;
        }

        Properties

        dispose? onDidDispose?

        Properties

        Optional dispose

        dispose?: UnsubscriberAsync

        Release resources and notify dependent services when tearing down an object

        -

        Optional onDidDispose

        onDidDispose?: undefined

        Event that emits when dispose is called on an object

        -

        Settings

        Member Visibility

        Theme

        On This Page

        disposeonDidDispose
        \ No newline at end of file +

        Optional onDidDispose

        onDidDispose?: undefined

        Event that emits when dispose is called on an object

        +

        Settings

        Member Visibility

        Theme

        On This Page

        disposeonDidDispose
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index fda36ebfcf..32b29b1805 100644 --- a/platform-bible-utils/interfaces/Dispose.html +++ b/platform-bible-utils/interfaces/Dispose.html @@ -1,4 +1,4 @@ Dispose | platform-bible-utils

        Interface Dispose

        Require a dispose function

        -
        interface Dispose {
            dispose: UnsubscriberAsync;
        }

        Implemented by

        Properties

        dispose +
        interface Dispose {
            dispose: UnsubscriberAsync;
        }

        Implemented by

        Properties

        dispose

        Properties

        dispose

        dispose: UnsubscriberAsync

        Release resources and notify dependent services when tearing down an object

        -

        Settings

        Member Visibility

        Theme

        On This Page

        dispose
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        dispose
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/LanguageStrings.html b/platform-bible-utils/interfaces/LanguageStrings.html index 826ebc6a55..fbb733274c 100644 --- a/platform-bible-utils/interfaces/LanguageStrings.html +++ b/platform-bible-utils/interfaces/LanguageStrings.html @@ -1,3 +1,3 @@ LanguageStrings | platform-bible-utils

        Interface LanguageStrings

        Map whose keys are localized string keys and whose values provide information about how to localize strings for the localized string key

        -
        interface LanguageStrings {
            [k: LocalizeKey]: LocalizedStringValue;
        }

        Indexable

        [k: LocalizeKey]: LocalizedStringValue

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface LanguageStrings {
            [k: LocalizeKey]: LocalizedStringValue;
        }

        Indexable

        [k: LocalizeKey]: LocalizedStringValue

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html index a91eeace33..30e3f7bb99 100644 --- a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html +++ b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html @@ -1,4 +1,4 @@ LocalizedStringDataContribution | platform-bible-utils

        Interface LocalizedStringDataContribution

        The data an extension provides to inform Platform.Bible of the localized strings it provides.

        -
        interface LocalizedStringDataContribution {
            localizedStrings?: {
                [k: string]: LanguageStrings;
            };
            metadata?: StringsMetadata;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        localizedStrings? +
        interface LocalizedStringDataContribution {
            localizedStrings?: {
                [k: string]: LanguageStrings;
            };
            metadata?: StringsMetadata;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        localizedStrings? metadata? -

        Properties

        Optional localizedStrings

        localizedStrings?: {
            [k: string]: LanguageStrings;
        }

        Type declaration

        Optional metadata

        metadata?: StringsMetadata

        Settings

        Member Visibility

        Theme

        On This Page

        localizedStringsmetadata
        \ No newline at end of file +

        Properties

        Optional localizedStrings

        localizedStrings?: {
            [k: string]: LanguageStrings;
        }

        Type declaration

        Optional metadata

        metadata?: StringsMetadata

        Settings

        Member Visibility

        Theme

        On This Page

        localizedStringsmetadata
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index a6c4beff61..5551b700b1 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

        platformType? +
        interface ModifierExtensionControlled {
            platformType?: undefined;
            type?: undefined;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        platformType? type? -

        Properties

        Optional platformType

        platformType?: undefined

        Optional type

        type?: undefined

        Settings

        Member Visibility

        Theme

        On This Page

        platformTypetype
        \ No newline at end of file +

        Properties

        Optional platformType

        platformType?: undefined

        Optional type

        type?: undefined

        Settings

        Member Visibility

        Theme

        On This Page

        platformTypetype
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index ff2867f6ee..a8df8e9b65 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,4 +1,4 @@ -ModifierProject | platform-bible-utils

        Interface ModifierProject

        interface ModifierProject {
            excludePdpFactoryIds?: string | string[];
            excludeProjectInterfaces?: string | (string | string[])[];
            includePdpFactoryIds?: string | string[];
            includeProjectInterfaces?: string | (string | string[])[];
        }

        Properties

        excludePdpFactoryIds? +ModifierProject | platform-bible-utils

        Interface ModifierProject

        interface ModifierProject {
            excludePdpFactoryIds?: string | string[];
            excludeProjectInterfaces?: string | (string | string[])[];
            includePdpFactoryIds?: string | string[];
            includeProjectInterfaces?: string | (string | string[])[];
        }

        Properties

        excludePdpFactoryIds? excludeProjectInterfaces? includePdpFactoryIds? includeProjectInterfaces? @@ -8,7 +8,7 @@ function) to determine if the projects should absolutely not be included even if they match with includeProjectInterfaces.

        Defaults to none, so all projects that match includePdpFactoryIds will be included

        -

        Optional excludeProjectInterfaces

        excludeProjectInterfaces?: string | (string | string[])[]

        String representation of RegExp pattern(s) to match against projects' projectInterfaces +

        Optional excludeProjectInterfaces

        excludeProjectInterfaces?: string | (string | string[])[]

        String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should absolutely not be included even if they match with @@ -35,13 +35,13 @@

      • Include one
      • Include both two and three.
        • -

        Optional includePdpFactoryIds

        includePdpFactoryIds?: string | string[]

        String representation of RegExp pattern(s) to match against the Project Data Provider Factory +

        Optional includePdpFactoryIds

        includePdpFactoryIds?: string | string[]

        String representation of RegExp pattern(s) to match against the Project Data Provider Factory Ids that provided each project's metadata (using the test function) to determine if the projects should be included.

        Defaults to all Project Data Provider Factory Ids, so all projects that do not match excludePdpFactoryIds will be included

        -

        Optional includeProjectInterfaces

        includeProjectInterfaces?: string | (string | string[])[]

        String representation of RegExp pattern(s) to match against projects' projectInterfaces +

        Optional includeProjectInterfaces

        includeProjectInterfaces?: string | (string | string[])[]

        String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included.

        @@ -67,4 +67,4 @@
      • Include one
      • Include both two and three.
        • -

        Settings

        Member Visibility

        Theme

        On This Page

        excludePdpFactoryIdsexcludeProjectInterfacesincludePdpFactoryIdsincludeProjectInterfaces
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        excludePdpFactoryIdsexcludeProjectInterfacesincludePdpFactoryIdsincludeProjectInterfaces
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 1aa10817b0..a92f83e4cc 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

        onDidDispose +
        interface OnDidDispose {
            onDidDispose: PlatformEvent<void>;
        }

        Properties

        onDidDispose

        Properties

        onDidDispose

        onDidDispose: PlatformEvent<void>

        Event that emits when dispose is called on an object

        -

        Settings

        Member Visibility

        Theme

        On This Page

        onDidDispose
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        onDidDispose
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 70974f0e79..8a0f28aba3 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

        [k: ReferencedItem]: ProjectSetting

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface ProjectSettingProperties {
            [k: ReferencedItem]: ProjectSetting;
        }

        Indexable

        [k: ReferencedItem]: ProjectSetting

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index a8ee1d7bd7..b64f076360 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

        description? +
        interface ProjectSettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: ProjectSettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        description? label properties

        Properties

        Optional description

        description?: `%${string}%`

        LocalizeKey that displays in the project settings dialog to describe the group

        -

        label

        label: `%${string}%`

        LocalizeKey that displays in the project settings dialog as the group name

        -

        properties

        properties: ProjectSettingProperties

        Settings

        Member Visibility

        Theme

        On This Page

        descriptionlabelproperties
        \ No newline at end of file +

        label

        label: `%${string}%`

        LocalizeKey that displays in the project settings dialog as the group name

        +

        properties

        properties: ProjectSettingProperties

        Settings

        Member Visibility

        Theme

        On This Page

        descriptionlabelproperties
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 0dee4378b8..7b112cf3ec 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

        [k: ReferencedItem]: UserState

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface ProjectStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        [k: ReferencedItem]: UserState

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index 3d73b1f5cd..692ea54470 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

        Interface ScriptureReference

        interface ScriptureReference {
            bookNum: number;
            chapterNum: number;
            verseNum: number;
        }

        Properties

        bookNum chapterNum verseNum -

        Properties

        bookNum

        bookNum: number

        chapterNum

        chapterNum: number

        verseNum

        verseNum: number

        Settings

        Member Visibility

        Theme

        On This Page

        bookNumchapterNumverseNum
        \ No newline at end of file +

        Properties

        bookNum

        bookNum: number

        chapterNum

        chapterNum: number

        verseNum

        verseNum: number

        Settings

        Member Visibility

        Theme

        On This Page

        bookNumchapterNumverseNum
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index 719cbdcb63..ea7b153194 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

        [k: ReferencedItem]: Setting

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface SettingProperties {
            [k: ReferencedItem]: Setting;
        }

        Indexable

        [k: ReferencedItem]: Setting

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index 6009c16310..2b532496a2 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

        description? +
        interface SettingsGroup {
            description?: `%${string}%`;
            label: `%${string}%`;
            properties: SettingProperties;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        description? label properties

        Properties

        Optional description

        description?: `%${string}%`

        LocalizeKey that displays in the settings dialog to describe the group

        -

        label

        label: `%${string}%`

        LocalizeKey that displays in the settings dialog as the group name

        -

        properties

        properties: SettingProperties

        Settings

        Member Visibility

        Theme

        On This Page

        descriptionlabelproperties
        \ No newline at end of file +

        label

        label: `%${string}%`

        LocalizeKey that displays in the settings dialog as the group name

        +

        properties

        properties: SettingProperties

        Settings

        Member Visibility

        Theme

        On This Page

        descriptionlabelproperties
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index aa25cdbc25..c7a19d9cfa 100644 --- a/platform-bible-utils/interfaces/StateBase.html +++ b/platform-bible-utils/interfaces/StateBase.html @@ -1,7 +1,7 @@ StateBase | platform-bible-utils

        Interface StateBase

        Base information needed to describe a state entry

        -
        interface StateBase {
            default: unknown;
            derivesFrom?: `${string}.${string}`;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        default +
        interface StateBase {
            default: unknown;
            derivesFrom?: `${string}.${string}`;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        default derivesFrom?

        Properties

        default

        default: unknown

        Default value for the state/setting

        -

        Optional derivesFrom

        derivesFrom?: `${string}.${string}`

        A state/setting ID whose value to set to this state/setting's starting value the first time +

        Optional derivesFrom

        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

        -

        Settings

        Member Visibility

        Theme

        On This Page

        defaultderivesFrom
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        defaultderivesFrom
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StringMetadata.html b/platform-bible-utils/interfaces/StringMetadata.html index b780e99ce8..b77757c9bf 100644 --- a/platform-bible-utils/interfaces/StringMetadata.html +++ b/platform-bible-utils/interfaces/StringMetadata.html @@ -1,9 +1,9 @@ StringMetadata | platform-bible-utils

        Interface StringMetadata

        Additional non-locale-specific information about a localized string key

        -
        interface StringMetadata {
            fallbackKey?: `%${string}%`;
            notes?: string;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        fallbackKey? +
        interface StringMetadata {
            fallbackKey?: `%${string}%`;
            notes?: string;
            [k: string]: unknown;
        }

        Indexable

        [k: string]: unknown

        Properties

        fallbackKey? notes?

        Properties

        Optional fallbackKey

        fallbackKey?: `%${string}%`

        Localized string key from which to get this value if one does not exist in the specified language. If a new key/value pair needs to be made to replace an existing one, this could help smooth over the transition if the meanings are close enough

        -

        Optional notes

        notes?: string

        Additional information provided by developers in English to help the translator to know how to +

        Optional notes

        notes?: string

        Additional information provided by developers in English to help the translator to know how to translate this localized string accurately

        -

        Settings

        Member Visibility

        Theme

        On This Page

        fallbackKeynotes
        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        On This Page

        fallbackKeynotes
        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StringsMetadata.html b/platform-bible-utils/interfaces/StringsMetadata.html index 665311e6eb..6980bd8c3f 100644 --- a/platform-bible-utils/interfaces/StringsMetadata.html +++ b/platform-bible-utils/interfaces/StringsMetadata.html @@ -1,3 +1,3 @@ StringsMetadata | platform-bible-utils

        Interface StringsMetadata

        Map whose keys are localized string keys and whose values provide additional non-locale-specific information about the localized string key

        -
        interface StringsMetadata {
            [k: LocalizeKey]: StringMetadata;
        }

        Indexable

        [k: LocalizeKey]: StringMetadata

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface StringsMetadata {
            [k: LocalizeKey]: StringMetadata;
        }

        Indexable

        [k: LocalizeKey]: StringMetadata

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index 407a87367d..5352984915 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

        [k: ReferencedItem]: UserState

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +
        interface UserStateContribution {
            [k: ReferencedItem]: UserState;
        }

        Indexable

        [k: ReferencedItem]: UserState

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 2423a19f07..b4b9dcddd4 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index a3fbc67bce..7f59477fbc 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index 60af5c8a06..fc27f64ced 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index 2ba0fd6c02..5d34d48563 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index ceaf8877fc..283e14e83f 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index 1419728218..e624a8271f 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index 98f6ad1eb8..f719827c69 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.

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index 9876978f7f..e045ca95ed 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index 33465a38f3..4cfbcff61d 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index 613df83db5..59bdcdee69 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +JsonDocumentLike | platform-bible-utils

        Type alias JsonDocumentLike

        JsonDocumentLike: JsonObjectLike | JsonArrayLike

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index 214601f71e..2bfdd967ca 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index 1cfe7f2a22..4b1348644a 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizedStringValue.html b/platform-bible-utils/types/LocalizedStringValue.html index 908c7aa322..e8b8a87877 100644 --- a/platform-bible-utils/types/LocalizedStringValue.html +++ b/platform-bible-utils/types/LocalizedStringValue.html @@ -1,2 +1,2 @@ LocalizedStringValue | platform-bible-utils

        Type alias LocalizedStringValue

        LocalizedStringValue: string

        Localized string value associated with this key

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index 5e1d3f5a4b..eb4da8a59c 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index 0bd2cc59e0..e9755ada8b 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index 69e395b0b8..52195463f8 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index e9bbd823c1..a3e469ecac 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

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index bf7b26130a..e3b4d81e17 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -2,4 +2,4 @@

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index 9f5c84c540..422a3b8041 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index 6285ff7f63..f59b79a8c5 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index b391f55d5e..4ec07aa8e9 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index 7bcd647078..efd03c167b 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)

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index b6235dba5e..daac49dab6 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index 397d8a1062..b68a4b6325 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index 21a78385e8..675d0843a7 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index 57179e9311..42be1ead83 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

        -

        • Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index 1ac1bfeb71..3df6103c2d 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

        ProjectSetting: ExtensionControlledProjectSetting

        A description of an extension's setting entry

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index 76da1e32d7..98a8087cb1 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index 5c85c9378d..7d22b4f026 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index 776eab8b00..957fa5f23b 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)

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index 05ce9da9f4..892ca89bb4 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type Parameters

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ScriptureNode.html b/platform-bible-utils/types/ScriptureNode.html index cd4a620062..040ff95a55 100644 --- a/platform-bible-utils/types/ScriptureNode.html +++ b/platform-bible-utils/types/ScriptureNode.html @@ -1,3 +1,3 @@ ScriptureNode | platform-bible-utils

        Type alias ScriptureNode

        ScriptureNode: ScriptureReference & {
            jsonPath: string;
        }

        Represents a "node" in the JSON used to present Scripture in the editor, with a path that is relative to the start of a verse.

        -

        Type declaration

        • jsonPath: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ScriptureSelection.html b/platform-bible-utils/types/ScriptureSelection.html index 2e4cdcbefc..c8a761f367 100644 --- a/platform-bible-utils/types/ScriptureSelection.html +++ b/platform-bible-utils/types/ScriptureSelection.html @@ -1,3 +1,3 @@ ScriptureSelection | platform-bible-utils

        Type alias ScriptureSelection

        ScriptureSelection: {
            end?: ScriptureNode | ScriptureTextAnchor;
            start: ScriptureNode | ScriptureTextAnchor;
        }

        Represents a range of text in the Scripture editor. The start and end node are expected to be in the same book.

        -

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/ScriptureTextAnchor.html b/platform-bible-utils/types/ScriptureTextAnchor.html index 1a65f570e1..4628f61ba0 100644 --- a/platform-bible-utils/types/ScriptureTextAnchor.html +++ b/platform-bible-utils/types/ScriptureTextAnchor.html @@ -1,2 +1,2 @@ ScriptureTextAnchor | platform-bible-utils

        Type alias ScriptureTextAnchor

        ScriptureTextAnchor: ScriptureNode & {
            offset: number;
        }

        Represents a specific character offset in the text of a textual Scripture node (in the editor.)

        -

        Type declaration

        • offset: number

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index 645aac07c3..b8209eacea 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

        Setting: ExtensionControlledSetting

        A description of an extension's setting entry

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index 18c99acba6..250d2ad5ec 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

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index 0de12b5d9c..92e293e520 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

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index 3d8a78453f..75f3489bb5 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/UnionToIntersection.html b/platform-bible-utils/types/UnionToIntersection.html index 71e17fd3e8..b4084a173e 100644 --- a/platform-bible-utils/types/UnionToIntersection.html +++ b/platform-bible-utils/types/UnionToIntersection.html @@ -2,4 +2,4 @@

        Note: this utility type is for use on object types. It may fail on other types.

        Type Parameters

        Example

        type TypeOne = { one: string };
        type TypeTwo = { two: number };
        type TypeThree = { three: string };

        type TypeNums = { one: TypeOne; two: TypeTwo; three: TypeThree };
        const numNames = ['one', 'two'] as const;
        type TypeNumNames = typeof numNames;

        // Same as `TypeOne | TypeTwo`
        // `{ one: string } | { two: number }`
        type TypeOneTwoUnion = TypeNums[TypeNumNames[number]];

        // Same as `TypeOne & TypeTwo`
        // `{ one: string; two: number }`
        type TypeOneTwoIntersection = UnionToIntersection<TypeOneTwoUnion>;
        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index 9db301c55d..cd3fdefd43 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index c9220a7690..61fb080f3e 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>

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index 74314a1930..fd2867e08b 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

        UserState: ExtensionControlledState

        A description of an extension's user state entry

        -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index d54c7031c9..8058ca722e 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index 244fb1223d..7c4e9c4893 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Settings

        Member Visibility

        Theme

        \ 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 0303c98bdb..3ca1293374 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +FIRST_SCR_BOOK_NUM | platform-bible-utils

        Variable FIRST_SCR_BOOK_NUMConst

        FIRST_SCR_BOOK_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ 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 332a1afa7c..9903331e02 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

        Variable FIRST_SCR_CHAPTER_NUMConst

        FIRST_SCR_CHAPTER_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ 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 40d8d48373..eb807cc049 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +FIRST_SCR_VERSE_NUM | platform-bible-utils

        Variable FIRST_SCR_VERSE_NUMConst

        FIRST_SCR_VERSE_NUM: 1 = 1

        Settings

        Member Visibility

        Theme

        \ 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 e2cb346498..ccfae6c0c3 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 = ...

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +LAST_SCR_BOOK_NUM | platform-bible-utils

        Variable LAST_SCR_BOOK_NUMConst

        LAST_SCR_BOOK_NUM: number = ...

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/localizedStringsDocumentSchema.html b/platform-bible-utils/variables/localizedStringsDocumentSchema.html index d3a1f62004..2b25abe321 100644 --- a/platform-bible-utils/variables/localizedStringsDocumentSchema.html +++ b/platform-bible-utils/variables/localizedStringsDocumentSchema.html @@ -1,2 +1,2 @@ localizedStringsDocumentSchema | platform-bible-utils

        Variable localizedStringsDocumentSchemaConst

        localizedStringsDocumentSchema: {
            $defs: {
                languageStrings: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^%[\w\-\.]+%$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
                localizeKey: {
                    description: string;
                    pattern: string;
                    tsType: string;
                    type: string;
                };
                localizedStringValue: {
                    description: string;
                    type: string;
                };
                stringMetadata: {
                    description: string;
                    properties: {
                        fallbackKey: {
                            $ref: string;
                            description: string;
                        };
                        notes: {
                            description: string;
                            type: string;
                        };
                    };
                    type: string;
                };
                stringsMetadata: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^%[\w\-\.]+%$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
            };
            $schema: string;
            description: string;
            properties: {
                localizedStrings: {
                    additionalProperties: {
                        $ref: string;
                    };
                    type: string;
                };
                metadata: {
                    $ref: string;
                };
            };
            title: string;
            type: string;
        } = ...

        JSON schema object that aligns with the LocalizedStringDataContribution type

        -

        Type declaration

        • $defs: {
              languageStrings: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^%[\w\-\.]+%$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
              localizeKey: {
                  description: string;
                  pattern: string;
                  tsType: string;
                  type: string;
              };
              localizedStringValue: {
                  description: string;
                  type: string;
              };
              stringMetadata: {
                  description: string;
                  properties: {
                      fallbackKey: {
                          $ref: string;
                          description: string;
                      };
                      notes: {
                          description: string;
                          type: string;
                      };
                  };
                  type: string;
              };
              stringsMetadata: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^%[\w\-\.]+%$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
          }
          • languageStrings: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^%[\w\-\.]+%$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^%[\w\-\.]+%$: {
                      $ref: string;
                  };
              }
              • ^%[\w\-\.]+%$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
          • localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            }
            • description: string
            • pattern: string
            • tsType: string
            • type: string
          • localizedStringValue: {
                description: string;
                type: string;
            }
            • description: string
            • type: string
          • stringMetadata: {
                description: string;
                properties: {
                    fallbackKey: {
                        $ref: string;
                        description: string;
                    };
                    notes: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            }
            • description: string
            • properties: {
                  fallbackKey: {
                      $ref: string;
                      description: string;
                  };
                  notes: {
                      description: string;
                      type: string;
                  };
              }
              • fallbackKey: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • notes: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
            • type: string
          • stringsMetadata: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^%[\w\-\.]+%$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^%[\w\-\.]+%$: {
                      $ref: string;
                  };
              }
              • ^%[\w\-\.]+%$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
        • $schema: string
        • description: string
        • properties: {
              localizedStrings: {
                  additionalProperties: {
                      $ref: string;
                  };
                  type: string;
              };
              metadata: {
                  $ref: string;
              };
          }
          • localizedStrings: {
                additionalProperties: {
                    $ref: string;
                };
                type: string;
            }
            • additionalProperties: {
                  $ref: string;
              }
              • $ref: string
            • type: string
          • metadata: {
                $ref: string;
            }
            • $ref: string
        • title: string
        • type: string

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index a359ac2425..4e45dcaabc 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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index 71cd27d82c..b9a40dc56b 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: {
                        excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                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: {
                      excludePdpFactoryIds: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      excludeProjectInterfaces: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      includePdpFactoryIds: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      includeProjectInterfaces: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              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: {
                    excludePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            }
            • description: string
            • properties: {
                  excludePdpFactoryIds: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  excludeProjectInterfaces: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              anyOf: ((...) | (...))[];
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  includePdpFactoryIds: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  includeProjectInterfaces: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              anyOf: ((...) | (...))[];
                          };
                          type: string;
                      })[];
                      description: string;
                  };
              }
              • excludePdpFactoryIds: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
              • excludeProjectInterfaces: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            anyOf: ((...) | (...))[];
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          anyOf: ((...) | (...))[];
                      };
                      type: string;
                  })[]
                • description: string
              • includePdpFactoryIds: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
              • includeProjectInterfaces: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            anyOf: ((...) | (...))[];
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          anyOf: ((...) | (...))[];
                      };
                      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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index 9d7967b2b3..d7c72fa80f 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: {
                        excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                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: {
                      excludePdpFactoryIds: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      excludeProjectInterfaces: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      includePdpFactoryIds: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      includeProjectInterfaces: {
                          anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              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: {
                    excludePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            }
            • description: string
            • properties: {
                  excludePdpFactoryIds: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  excludeProjectInterfaces: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              anyOf: ((...) | (...))[];
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  includePdpFactoryIds: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              type: string;
                          };
                          type: string;
                      })[];
                      description: string;
                  };
                  includeProjectInterfaces: {
                      anyOf: ({
                          items?: undefined;
                          type: string;
                      } | {
                          items: {
                              anyOf: ((...) | (...))[];
                          };
                          type: string;
                      })[];
                      description: string;
                  };
              }
              • excludePdpFactoryIds: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
              • excludeProjectInterfaces: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            anyOf: ((...) | (...))[];
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          anyOf: ((...) | (...))[];
                      };
                      type: string;
                  })[]
                • description: string
              • includePdpFactoryIds: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            type: string;
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          type: string;
                      };
                      type: string;
                  })[]
                • description: string
              • includeProjectInterfaces: {
                    anyOf: ({
                        items?: undefined;
                        type: string;
                    } | {
                        items: {
                            anyOf: ((...) | (...))[];
                        };
                        type: string;
                    })[];
                    description: string;
                }
                • anyOf: ({
                      items?: undefined;
                      type: string;
                  } | {
                      items: {
                          anyOf: ((...) | (...))[];
                      };
                      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

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

        Type declaration

        Settings

        Member Visibility

        Theme

        \ No newline at end of file