From 1412f99ab67786617930aa95dedc7fc4ae9f1c02 Mon Sep 17 00:00:00 2001 From: tjcouch-sil <104016682+tjcouch-sil@users.noreply.github.com> Date: Mon, 12 Feb 2024 16:09:35 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20github-pages=20from=20@=20para?= =?UTF-8?q?next/paranext-core@1429705f7ae13f08873ae40c94ae1b723b1dfb16=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...nt_network_connector_service_.default.html | 52 +++++++------- ...er_network_connector_service_.default.html | 70 +++++++++---------- ...execution_token_model_.ExecutionToken.html | 4 +- ..._renderer_web_socket_service_.default.html | 4 +- ...rer_xml_http_request_service_.default.html | 4 +- ..._network_event_emitter_model_.default.html | 20 +++--- ..._provider_service_.DataProviderEngine.html | 4 +- ...s_node_file_system_service_.EntryType.html | 4 +- ...al_connection_model_.ConnectionStatus.html | 8 +-- ..._network_connector_model_.MessageType.html | 4 +- ...shared_global_this_model_.ProcessType.html | 4 +- ...ls_web_view_model_.WebViewContentType.html | 8 +-- ...shared_utils_util_.RequestHandlerType.html | 4 +- papi-dts/functions/__papi_backend_.fetch.html | 4 +- .../functions/__papi_frontend_.fetch.html | 4 +- ...s_web_socket_factory_.createWebSocket.html | 2 +- ...e_service_.buildExtensionPathFromName.html | 2 +- ...ion_storage_service_.setExtensionUris.html | 2 +- ...es_node_file_system_service_.copyFile.html | 2 +- ...s_node_file_system_service_.createDir.html | 2 +- ...s_node_file_system_service_.deleteDir.html | 2 +- ..._node_file_system_service_.deleteFile.html | 2 +- ...es_node_file_system_service_.getStats.html | 2 +- ...ces_node_file_system_service_.readDir.html | 2 +- ...e_file_system_service_.readFileBinary.html | 2 +- ...ode_file_system_service_.readFileText.html | 2 +- ...vices_node_file_system_service_.touch.html | 2 +- ...s_node_file_system_service_.writeFile.html | 2 +- .../_node_utils_crypto_util_.createNonce.html | 2 +- .../_node_utils_crypto_util_.createUuid.html | 2 +- .../_node_utils_util_.getAppDir.html | 2 +- .../_node_utils_util_.getPathFromUri.html | 2 +- .../_node_utils_util_.joinUriPaths.html | 2 +- .../_node_utils_util_.resolveHtmlPath.html | 2 +- ...dialog_base_data_.hookUpDialogService.html | 2 +- ...rs_create_use_data_hook_util_.default.html | 2 +- ...use_network_object_hook_util_.default.html | 2 +- ...oks_papi_hooks_use_data_hook_.default.html | 2 +- ...hooks_use_data_provider_hook_.default.html | 2 +- ...use_data_provider_multi_hook_.default.html | 2 +- ...oks_use_dialog_callback_hook_.default.html | 4 +- ..._hooks_use_project_data_hook_.default.html | 2 +- ...e_project_data_provider_hook_.default.html | 2 +- ..._papi_hooks_use_setting_hook_.default.html | 2 +- ...service_.blockWebSocketsToPapiNetwork.html | 2 +- ...tDataProviderDataTypeFromFunctionName.html | 2 +- ...ed_services_command_service_.addThree.html | 2 +- ...nd_service_.createSendCommandFunction.html | 2 +- ..._services_command_service_.initialize.html | 2 +- ...ices_command_service_.registerCommand.html | 2 +- ...services_command_service_.sendCommand.html | 2 +- ...ices_command_service_.squareAndConcat.html | 2 +- ..._services_connection_service_.connect.html | 2 +- ...rvices_connection_service_.disconnect.html | 2 +- ...onnection_service_.emitEventOnNetwork.html | 2 +- ...vices_connection_service_.getClientId.html | 2 +- ..._services_connection_service_.request.html | 2 +- ...ices_data_provider_service_.getByType.html | 2 +- ...rovider_service_.registerEngineByType.html | 2 +- ...ed_services_logger_service_.formatLog.html | 2 +- ...ector_factory_.createNetworkConnector.html | 2 +- ...ect_service_.onDidCreateNetworkObject.html | 2 +- ...ct_service_.onDidDisposeNetworkObject.html | 2 +- ...twork_object_service_.overrideDispose.html | 2 +- ...rk_service_.createNetworkEventEmitter.html | 2 +- ...etwork_service_.createRequestFunction.html | 2 +- ...ices_network_service_.getNetworkEvent.html | 2 +- ..._services_network_service_.initialize.html | 2 +- ...s_network_service_.onDidClientConnect.html | 2 +- ...etwork_service_.onDidClientDisconnect.html | 2 +- ...twork_service_.registerRequestHandler.html | 2 +- ...red_services_network_service_.request.html | 2 +- ...ed_services_network_service_.shutdown.html | 2 +- ...es_project_data_provider_service_.get.html | 2 +- ...isterProjectDataProviderEngineFactory.html | 2 +- ...d_utils_internal_util_.getProcessType.html | 2 +- ..._shared_utils_internal_util_.isClient.html | 2 +- ..._utils_internal_util_.isExtensionHost.html | 2 +- ...hared_utils_internal_util_.isRenderer.html | 2 +- ..._shared_utils_internal_util_.isServer.html | 2 +- ...ared_utils_util_.createSafeRegisterFn.html | 2 +- ...ed_utils_util_.deserializeRequestType.html | 2 +- ...tils_util_.getModuleSimilarApiMessage.html | 2 +- .../_shared_utils_util_.newNonce.html | 2 +- ...ared_utils_util_.serializeRequestType.html | 2 +- ...tWebViewDefinitionUpdatableProperties.html | 2 +- ...ViewDefinitionUpdatablePropertiesById.html | 2 +- papi-dts/functions/getWebViewState.html | 2 +- papi-dts/functions/resetWebViewState.html | 2 +- papi-dts/functions/setWebViewState.html | 2 +- .../functions/updateWebViewDefinition.html | 2 +- .../updateWebViewDefinitionById.html | 2 +- papi-dts/functions/useWebViewState.html | 2 +- papi-dts/functions/webViewComponent.html | 2 +- ...types_extension_interface_.IExtension.html | 6 +- ...rage_service_.ExtensionStorageService.html | 12 ++-- .../_papi_shared_types_.CommandHandlers.html | 4 +- .../_papi_shared_types_.DataProviders.html | 4 +- ...pi_shared_types_.ProjectDataProviders.html | 4 +- .../_papi_shared_types_.SettingTypes.html | 4 +- ..._dialog_definition_model_.DialogTypes.html | 4 +- ..._docking_framework_model_.FloatLayout.html | 6 +- ..._docking_framework_model_.PanelLayout.html | 6 +- ...ls_docking_framework_model_.TabLayout.html | 4 +- ...del_.ProjectDataProviderEngineFactory.html | 4 +- ...ider_model_.DisposableWebViewProvider.html | 8 +-- ...view_provider_model_.IWebViewProvider.html | 8 +-- ..._view_provider_model_.WebViewProvider.html | 8 +-- ...provider_service_.DataProviderService.html | 12 ++-- ...s_dialog_service_model_.DialogService.html | 6 +- ...ces_internet_service_.InternetService.html | 4 +- ..._network_connector_interface_.default.html | 16 ++--- ....NetworkObjectStatusRemoteServiceType.html | 4 +- ...model_.NetworkObjectStatusServiceType.html | 6 +- ...s_network_service_.PapiNetworkService.html | 6 +- ...PapiBackendProjectDataProviderService.html | 6 +- ...apiFrontendProjectDataProviderService.html | 4 +- ...rvice_model_.ProjectLookupServiceType.html | 6 +- ...ces_settings_service_.SettingsService.html | 10 +-- ...r_service_.PapiWebViewProviderService.html | 4 +- ...vider_service_.WebViewProviderService.html | 10 +-- ...iew_service_model_.WebViewServiceType.html | 6 +- papi-dts/modules/__papi_backend_.html | 2 +- papi-dts/modules/__papi_core_.html | 2 +- papi-dts/modules/__papi_frontend_.html | 2 +- papi-dts/modules/__papi_frontend_react_.html | 2 +- ...ces_client_network_connector_service_.html | 2 +- .../_client_services_web_socket_factory_.html | 2 +- ...client_services_web_socket_interface_.html | 2 +- ...s_extension_activation_context_model_.html | 2 +- ..._extension_types_extension_interface_.html | 2 +- ...nsion_types_extension_manifest_model_.html | 2 +- ...ices_extension_host_web_socket_model_.html | 2 +- ...t_services_extension_storage_service_.html | 2 +- ...ces_server_network_connector_service_.html | 2 +- .../_node_models_execution_token_model_.html | 2 +- ...ode_services_execution_token_service_.html | 2 +- ...de_services_node_file_system_service_.html | 2 +- .../modules/_node_utils_crypto_util_.html | 2 +- papi-dts/modules/_node_utils_util_.html | 2 +- papi-dts/modules/_papi_shared_types_.html | 2 +- ..._components_dialogs_dialog_base_data_.html | 2 +- ...ents_dialogs_dialog_definition_model_.html | 2 +- ...generators_create_use_data_hook_util_.html | 2 +- ..._create_use_network_object_hook_util_.html | 2 +- .../_renderer_hooks_papi_hooks_index_.html | 2 +- ...derer_hooks_papi_hooks_use_data_hook_.html | 2 +- ...ks_papi_hooks_use_data_provider_hook_.html | 2 +- ...i_hooks_use_data_provider_multi_hook_.html | 2 +- ..._papi_hooks_use_dialog_callback_hook_.html | 2 +- ...oks_papi_hooks_use_project_data_hook_.html | 2 +- ...hooks_use_project_data_provider_hook_.html | 2 +- ...er_hooks_papi_hooks_use_setting_hook_.html | 2 +- ...services_renderer_web_socket_service_.html | 2 +- ...es_renderer_xml_http_request_service_.html | 2 +- .../_shared_data_file_system_model_.html | 2 +- ...hared_data_internal_connection_model_.html | 2 +- ..._shared_data_network_connector_model_.html | 2 +- .../modules/_shared_global_this_model_.html | 2 +- ...ed_models_data_provider_engine_model_.html | 2 +- ...hared_models_data_provider_interface_.html | 2 +- .../_shared_models_data_provider_model_.html | 2 +- .../_shared_models_dialog_options_model_.html | 2 +- ...hared_models_docking_framework_model_.html | 2 +- ...tract_data_provider_data_types_model_.html | 2 +- .../_shared_models_network_object_model_.html | 2 +- ...els_papi_network_event_emitter_model_.html | 2 +- ...s_project_data_provider_engine_model_.html | 2 +- ...d_models_project_data_provider_model_.html | 2 +- ...shared_models_project_metadata_model_.html | 2 +- .../_shared_models_web_view_model_.html | 2 +- ...hared_models_web_view_provider_model_.html | 2 +- .../_shared_services_command_service_.html | 2 +- .../_shared_services_connection_service_.html | 2 +- ...hared_services_data_provider_service_.html | 2 +- .../_shared_services_dialog_service_.html | 2 +- ...shared_services_dialog_service_model_.html | 2 +- .../_shared_services_internet_service_.html | 2 +- .../_shared_services_logger_service_.html | 2 +- .../_shared_services_menu_data_service_.html | 2 +- ...red_services_menu_data_service_model_.html | 2 +- ...d_services_network_connector_factory_.html | 2 +- ...services_network_connector_interface_.html | 2 +- ...ared_services_network_object_service_.html | 2 +- ...rvices_network_object_status_service_.html | 2 +- ..._network_object_status_service_model_.html | 2 +- .../_shared_services_network_service_.html | 2 +- ...rvices_project_data_provider_service_.html | 2 +- ...ared_services_project_lookup_service_.html | 2 +- ...ervices_project_lookup_service_model_.html | 2 +- .../_shared_services_settings_service_.html | 2 +- ...d_services_web_view_provider_service_.html | 2 +- .../_shared_services_web_view_service_.html | 2 +- ...ared_services_web_view_service_model_.html | 2 +- .../modules/_shared_utils_internal_util_.html | 2 +- papi-dts/modules/_shared_utils_util_.html | 2 +- papi-dts/types/__papi_frontend_.Papi.html | 2 +- ...ices_web_socket_interface_.IWebSocket.html | 2 +- ...ext_model_.ExecutionActivationContext.html | 2 +- ...ion_manifest_model_.ExtensionManifest.html | 2 +- ...ution_token_model_.ExecutionTokenType.html | 2 +- ...file_system_service_.DirectoryEntries.html | 2 +- .../_papi_shared_types_.CommandNames.html | 2 +- ..._papi_shared_types_.DataProviderNames.html | 2 +- ..._papi_shared_types_.DataProviderTypes.html | 2 +- ...shared_types_.DisposableDataProviders.html | 2 +- ...ared_types_.NotesOnlyProjectDataTypes.html | 2 +- ...pi_shared_types_.PlaceholderDataTypes.html | 2 +- .../_papi_shared_types_.ProjectDataTypes.html | 2 +- .../_papi_shared_types_.ProjectTypes.html | 2 +- .../_papi_shared_types_.SettingNames.html | 2 +- .../_papi_shared_types_.StuffDataTypes.html | 2 +- ...ialog_base_data_.DialogDefinitionBase.html | 2 +- ...dialogs_dialog_base_data_.DialogProps.html | 6 +- ...log_definition_model_.DialogDataTypes.html | 2 +- ...og_definition_model_.DialogDefinition.html | 2 +- ...alog_definition_model_.DialogTabTypes.html | 2 +- ..._.SelectMultipleProjectsDialogOptions.html | 2 +- ...ion_model_.SelectProjectDialogOptions.html | 2 +- ...llback_hook_.UseDialogCallbackOptions.html | 2 +- .../_shared_data_file_system_model_.Uri.html | 2 +- ..._connection_model_.ClientConnectEvent.html | 2 +- ...nnection_model_.ClientDisconnectEvent.html | 2 +- ...ernal_connection_model_.InternalEvent.html | 2 +- ...on_model_.InternalNetworkEventHandler.html | 2 +- ...nal_connection_model_.InternalRequest.html | 2 +- ...nection_model_.InternalRequestHandler.html | 2 +- ...al_connection_model_.InternalResponse.html | 2 +- ..._model_.NetworkConnectorEventHandlers.html | 2 +- ...onnection_model_.NetworkConnectorInfo.html | 2 +- ...connection_model_.NetworkEventHandler.html | 2 +- ...rnal_connection_model_.RequestHandler.html | 2 +- ...ernal_connection_model_.RequestRouter.html | 2 +- ...etwork_connector_model_.ClientConnect.html | 2 +- ...a_network_connector_model_.InitClient.html | 2 +- ...data_network_connector_model_.Message.html | 2 +- ...twork_connector_model_.WebSocketEvent.html | 2 +- ...ork_connector_model_.WebSocketRequest.html | 2 +- ...rk_connector_model_.WebSocketResponse.html | 2 +- ...model_.DataProviderEngineNotifyUpdate.html | 2 +- ...ovider_engine_model_.WithNotifyUpdate.html | 2 +- ...s_data_provider_engine_model_.default.html | 2 +- ...er_interface_.IDisposableDataProvider.html | 2 +- ...dels_data_provider_interface_.default.html | 2 +- ..._provider_model_.DataProviderDataType.html | 2 +- ...provider_model_.DataProviderDataTypes.html | 2 +- ...ta_provider_model_.DataProviderGetter.html | 2 +- ...a_provider_model_.DataProviderGetters.html | 2 +- ...ta_provider_model_.DataProviderSetter.html | 2 +- ...a_provider_model_.DataProviderSetters.html | 2 +- ...rovider_model_.DataProviderSubscriber.html | 2 +- ..._model_.DataProviderSubscriberOptions.html | 2 +- ...ovider_model_.DataProviderSubscribers.html | 2 +- ...model_.DataProviderUpdateInstructions.html | 2 +- ...ls_data_provider_model_.DataTypeNames.html | 2 +- ...d_models_data_provider_model_.default.html | 2 +- ...dels_dialog_options_model_.DialogData.html | 2 +- ...s_dialog_options_model_.DialogOptions.html | 2 +- ...king_framework_model_.AddWebViewEvent.html | 2 +- ...ocking_framework_model_.FloatPosition.html | 2 +- ...ls_docking_framework_model_.FloatSize.html | 2 +- ...odels_docking_framework_model_.Layout.html | 2 +- ...framework_model_.OnLayoutChangeRCDock.html | 2 +- ...cking_framework_model_.PanelDirection.html | 2 +- ...cking_framework_model_.PapiDockLayout.html | 2 +- ...docking_framework_model_.SavedTabInfo.html | 2 +- ...dels_docking_framework_model_.TabInfo.html | 2 +- ...ls_docking_framework_model_.TabLoader.html | 2 +- ...els_docking_framework_model_.TabSaver.html | 2 +- ...king_framework_model_.WebViewTabProps.html | 2 +- ...ta_provider_data_types_model_.default.html | 2 +- ...object_model_.DisposableNetworkObject.html | 2 +- ...ject_model_.LocalObjectToProxyCreator.html | 2 +- ...s_network_object_model_.NetworkObject.html | 2 +- ...rk_object_model_.NetworkObjectDetails.html | 2 +- ...twork_object_model_.NetworkableObject.html | 2 +- ...model_.ProjectDataProviderEngineTypes.html | 2 +- ...ta_provider_model_.ExtensionDataScope.html | 2 +- ...vider_model_.MandatoryProjectDataType.html | 2 +- ...oject_metadata_model_.ProjectMetadata.html | 2 +- ...tWebViewDefinitionUpdatableProperties.html | 2 +- ...els_web_view_model_.GetWebViewOptions.html | 2 +- ...eb_view_model_.SavedWebViewDefinition.html | 2 +- ...b_view_model_.UpdateWebViewDefinition.html | 2 +- ...s_web_view_model_.UseWebViewStateHook.html | 2 +- ...els_web_view_model_.WebViewDefinition.html | 2 +- ...web_view_model_.WebViewDefinitionBase.html | 2 +- ...web_view_model_.WebViewDefinitionHtml.html | 2 +- ...eb_view_model_.WebViewDefinitionReact.html | 2 +- ..._web_view_model_.WebViewDefinitionURL.html | 2 +- ....WebViewDefinitionUpdatableProperties.html | 2 +- ...ew_model_.WebViewDefinitionUpdateInfo.html | 2 +- ...ared_models_web_view_model_.WebViewId.html | 2 +- ...d_models_web_view_model_.WebViewProps.html | 2 +- ...ed_models_web_view_model_.WebViewType.html | 2 +- ...ommand_service_.moduleSummaryComments.html | 2 +- ..._data_service_model_.IMenuDataService.html | 14 ++-- ...data_service_model_.MenuDataDataTypes.html | 2 +- ...s_network_service_.ArgsRequestHandler.html | 2 +- ...etwork_service_.ComplexRequestHandler.html | 2 +- ...twork_service_.ContentsRequestHandler.html | 2 +- ...s_settings_service_.ResetSettingEvent.html | 2 +- ...rvices_settings_service_.SettingEvent.html | 2 +- ..._settings_service_.UpdateSettingEvent.html | 2 +- .../_shared_utils_util_.ComplexRequest.html | 2 +- .../_shared_utils_util_.ComplexResponse.html | 2 +- ...ed_utils_util_.ComplexResponseFailure.html | 2 +- ...ed_utils_util_.ComplexResponseSuccess.html | 2 +- .../_shared_utils_util_.RequestType.html | 2 +- ...red_utils_util_.SerializedRequestType.html | 2 +- .../__papi_backend_.DataProviderEngine.html | 2 +- .../variables/__papi_backend_.commands.html | 2 +- .../__papi_backend_.dataProviders.html | 2 +- .../variables/__papi_backend_.default.html | 2 +- .../variables/__papi_backend_.dialogs.html | 2 +- .../variables/__papi_backend_.internet.html | 2 +- .../variables/__papi_backend_.logger.html | 2 +- .../variables/__papi_backend_.menuData.html | 2 +- .../variables/__papi_backend_.network.html | 2 +- .../__papi_backend_.projectDataProviders.html | 2 +- .../__papi_backend_.projectLookup.html | 2 +- .../variables/__papi_backend_.storage.html | 2 +- .../__papi_backend_.webViewProviders.html | 2 +- .../variables/__papi_backend_.webViews.html | 2 +- papi-dts/variables/__papi_core_.default.html | 2 +- .../variables/__papi_frontend_.WebSocket.html | 2 +- .../__papi_frontend_.XMLHttpRequest.html | 2 +- .../variables/__papi_frontend_.commands.html | 2 +- .../__papi_frontend_.dataProviders.html | 2 +- .../variables/__papi_frontend_.default.html | 2 +- .../variables/__papi_frontend_.dialogs.html | 2 +- .../variables/__papi_frontend_.internet.html | 2 +- .../variables/__papi_frontend_.logger.html | 2 +- .../variables/__papi_frontend_.menuData.html | 2 +- .../variables/__papi_frontend_.network.html | 2 +- ...__papi_frontend_.projectDataProviders.html | 2 +- .../__papi_frontend_.projectLookup.html | 2 +- .../variables/__papi_frontend_.react.html | 2 +- .../variables/__papi_frontend_.settings.html | 2 +- .../variables/__papi_frontend_.webViews.html | 2 +- ...es_extension_storage_service_.default.html | 2 +- ...ices_execution_token_service_.default.html | 2 +- .../_node_utils_util_.FILE_PROTOCOL.html | 2 +- .../_node_utils_util_.RESOURCES_PROTOCOL.html | 2 +- ...nts_dialogs_dialog_base_data_.default.html | 2 +- ....SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html | 2 +- ...ion_model_.SELECT_PROJECT_DIALOG_TYPE.html | 2 +- ...al_connection_model_.CATEGORY_COMMAND.html | 2 +- ...al_connection_model_.CLIENT_ID_SERVER.html | 2 +- ...onnection_model_.CLIENT_ID_UNASSIGNED.html | 2 +- ...on_model_.CONNECTOR_INFO_DISCONNECTED.html | 2 +- ...nnector_model_.WEBSOCKET_ATTEMPTS_MAX.html | 2 +- ...nector_model_.WEBSOCKET_ATTEMPTS_WAIT.html | 2 +- ...twork_connector_model_.WEBSOCKET_PORT.html | 2 +- ...rvices_data_provider_service_.default.html | 2 +- ...ared_services_dialog_service_.default.html | 2 +- ...dialog_service_model_.CATEGORY_DIALOG.html | 2 +- ...ed_services_internet_service_.default.html | 2 +- ...red_services_logger_service_.WARN_TAG.html | 2 +- ...ared_services_logger_service_.default.html | 2 +- ...d_services_menu_data_service_.default.html | 2 +- ...e_model_.menuDataServiceObjectToProxy.html | 2 +- ...ce_model_.menuDataServiceProviderName.html | 2 +- ...vices_network_object_service_.default.html | 2 +- ...etwork_object_status_service_.default.html | 2 +- ...kObjectStatusServiceNetworkObjectName.html | 2 +- ...network_service_.papiNetworkService-1.html | 2 +- ...piBackendProjectDataProviderService-1.html | 2 +- ...iFrontendProjectDataProviderService-1.html | 2 +- ...vices_project_lookup_service_.default.html | 2 +- ...projectLookupServiceNetworkObjectName.html | 2 +- ...ed_services_settings_service_.default.html | 2 +- ...es_web_view_provider_service_.default.html | 2 +- ...service_.papiWebViewProviderService-1.html | 2 +- ...ed_services_web_view_service_.default.html | 2 +- ...model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html | 2 +- ....NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html | 2 +- ...hared_utils_util_.MODULE_SIMILAR_APIS.html | 2 +- ...ed_utils_util_.REQUEST_TYPE_SEPARATOR.html | 2 +- papi-dts/variables/isPackaged.html | 2 +- papi-dts/variables/logLevel.html | 2 +- papi-dts/variables/processType.html | 2 +- papi-dts/variables/resourcesPath.html | 2 +- platform-bible-react/enums/LabelPosition.html | 4 +- platform-bible-react/functions/Button.html | 2 +- .../functions/ChapterRangeSelector.html | 2 +- platform-bible-react/functions/Checkbox.html | 2 +- platform-bible-react/functions/ComboBox.html | 2 +- platform-bible-react/functions/GridMenu.html | 2 +- .../functions/IconButton.html | 2 +- platform-bible-react/functions/MenuItem.html | 2 +- .../functions/RefSelector.html | 2 +- platform-bible-react/functions/SearchBar.html | 2 +- platform-bible-react/functions/Slider.html | 2 +- platform-bible-react/functions/Snackbar.html | 2 +- platform-bible-react/functions/Switch.html | 2 +- platform-bible-react/functions/Table.html | 2 +- platform-bible-react/functions/TextField.html | 2 +- platform-bible-react/functions/Toolbar.html | 2 +- platform-bible-react/functions/useEvent.html | 2 +- .../functions/useEventAsync.html | 2 +- .../functions/usePromise.html | 2 +- .../interfaces/CommandHandler.html | 2 +- .../interfaces/ScrRefSelectorProps.html | 4 +- .../interfaces/TableCalculatedColumn.html | 12 ++-- .../interfaces/ToolbarDataHandler.html | 2 +- platform-bible-react/types/AnchorOrigin.html | 2 +- platform-bible-react/types/ButtonProps.html | 2 +- .../types/ChapterRangeSelectorProps.html | 2 +- platform-bible-react/types/CheckboxProps.html | 2 +- platform-bible-react/types/CloseReason.html | 2 +- .../types/ComboBoxChangeDetails.html | 2 +- .../types/ComboBoxChangeReason.html | 2 +- .../types/ComboBoxLabelOption.html | 2 +- .../types/ComboBoxOption.html | 2 +- platform-bible-react/types/ComboBoxProps.html | 2 +- platform-bible-react/types/ComboBoxValue.html | 2 +- platform-bible-react/types/Command.html | 2 +- platform-bible-react/types/GridMenuInfo.html | 2 +- platform-bible-react/types/GridMenuProps.html | 2 +- .../types/IconButtonProps.html | 2 +- platform-bible-react/types/MenuColumn.html | 2 +- platform-bible-react/types/MenuItemInfo.html | 2 +- platform-bible-react/types/MenuItemProps.html | 2 +- .../types/SearchBarProps.html | 2 +- platform-bible-react/types/SliderProps.html | 2 +- .../types/SnackbarContentProps.html | 2 +- platform-bible-react/types/SnackbarProps.html | 2 +- platform-bible-react/types/SwitchProps.html | 2 +- .../types/TableCellClickArgs.html | 2 +- .../types/TableCellKeyDownArgs.html | 2 +- .../types/TableCellKeyboardEvent.html | 2 +- .../types/TableCellMouseEvent.html | 2 +- platform-bible-react/types/TableColumn.html | 2 +- .../types/TableCopyEvent.html | 2 +- .../types/TableEditorProps.html | 2 +- .../types/TablePasteEvent.html | 2 +- platform-bible-react/types/TableProps.html | 2 +- .../types/TableRowsChangeData.html | 2 +- .../types/TableSortColumn.html | 2 +- .../types/TextFieldProps.html | 2 +- platform-bible-react/types/ToolbarProps.html | 2 +- .../types/UsePromiseOptions.html | 2 +- .../classes/AsyncVariable.html | 14 ++-- .../classes/DocumentCombinerEngine.html | 20 +++--- .../classes/PlatformEventEmitter.html | 22 +++--- .../classes/UnsubscriberAsyncList.html | 8 +-- .../aggregateUnsubscriberAsyncs.html | 2 +- .../functions/aggregateUnsubscribers.html | 2 +- .../createSyncProxyForAsyncObject.html | 2 +- platform-bible-utils/functions/debounce.html | 2 +- platform-bible-utils/functions/deepClone.html | 2 +- platform-bible-utils/functions/deepEqual.html | 2 +- .../functions/deserialize.html | 2 +- .../functions/getAllObjectFunctionNames.html | 2 +- .../functions/getChaptersForBook.html | 2 +- .../functions/getErrorMessage.html | 2 +- platform-bible-utils/functions/groupBy.html | 2 +- .../functions/htmlEncode.html | 2 +- .../functions/isSerializable.html | 2 +- platform-bible-utils/functions/isString.html | 2 +- platform-bible-utils/functions/newGuid.html | 2 +- .../functions/offsetBook.html | 2 +- .../functions/offsetChapter.html | 2 +- .../functions/offsetVerse.html | 2 +- platform-bible-utils/functions/serialize.html | 2 +- platform-bible-utils/functions/wait.html | 2 +- .../functions/waitForDuration.html | 2 +- platform-bible-utils/interfaces/BookInfo.html | 4 +- .../interfaces/CannotHaveOnDidDispose.html | 6 +- platform-bible-utils/interfaces/Dispose.html | 4 +- .../interfaces/OnDidDispose.html | 4 +- .../interfaces/ScriptureReference.html | 4 +- .../types/CanHaveOnDidDispose.html | 2 +- .../types/ColumnsWithHeaders.html | 2 +- .../types/DocumentCombinerOptions.html | 2 +- platform-bible-utils/types/Groups.html | 2 +- .../types/JsonDocumentLike.html | 2 +- platform-bible-utils/types/LocalizeKey.html | 2 +- .../types/MenuColumnWithHeader.html | 2 +- .../types/MenuGroupDetailsInColumn.html | 2 +- .../types/MenuGroupDetailsInSubMenu.html | 2 +- platform-bible-utils/types/MenuItemBase.html | 2 +- .../types/MenuItemContainingCommand.html | 2 +- .../types/MenuItemContainingSubmenu.html | 2 +- .../types/MultiColumnMenu.html | 2 +- .../types/OrderedExtensibleContainer.html | 2 +- platform-bible-utils/types/OrderedItem.html | 2 +- platform-bible-utils/types/PlatformEvent.html | 2 +- .../types/PlatformEventAsync.html | 2 +- .../types/PlatformEventHandler.html | 2 +- platform-bible-utils/types/PlatformMenus.html | 2 +- .../types/ReferencedItem.html | 2 +- .../types/SingleColumnMenu.html | 2 +- platform-bible-utils/types/Unsubscriber.html | 2 +- .../types/UnsubscriberAsync.html | 2 +- platform-bible-utils/types/WebViewMenu.html | 2 +- platform-bible-utils/types/WebViewMenus.html | 2 +- .../variables/FIRST_SCR_BOOK_NUM.html | 2 +- .../variables/FIRST_SCR_CHAPTER_NUM.html | 2 +- .../variables/FIRST_SCR_VERSE_NUM.html | 2 +- .../variables/LAST_SCR_BOOK_NUM.html | 2 +- .../variables/menuDocumentSchema.html | 2 +- 503 files changed, 700 insertions(+), 700 deletions(-) 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 a2499c7338..705c014def 100644 --- a/papi-dts/classes/_client_services_client_network_connector_service_.default.html +++ b/papi-dts/classes/_client_services_client_network_connector_service_.default.html @@ -1,5 +1,5 @@ default | papi-dts

Handles the connection from the client to the server

-

Implements

Constructors

Implements

Constructors

Properties

clientGuid: any

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

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

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

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

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

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

    Param: localEventHandler

    Function that handles events from the server

    Param: networkConnectorEventHandlers

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

    Returns

    Promise that resolves with connector info when finished connecting

    -
connectPromise?: any

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

connectPromise?: any

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

-
connectionStatus: ConnectionStatus

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

connectionStatus: ConnectionStatus

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

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

Information about the connector. Populated by the server while connecting

-

Type declaration

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

Disconnects from the connection:

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

Information about the connector. Populated by the server while connecting

+

Type declaration

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

Disconnects from the connection:

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

Type declaration

    • (): void
    • Returns void

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

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

Type declaration

    • (): void
    • Returns void

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

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

Type declaration

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

      • T

      Parameters

      Returns Promise<void>

Param: eventType

Unique network event type for coordinating between processes

Param: event

Event to emit on the network

-
handleEventMessage: any

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

handleEventMessage: any

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

Param: eventMessage

Event message to handle

-
handleRequestMessage: any

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

handleRequestMessage: any

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

Param: requestMessage

Request message to handle

Param: isIncoming

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

-
handleResponseMessage: any

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

handleResponseMessage: any

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

Param: response

Response message to resolve

-
localEventHandler?: any

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

localEventHandler?: any

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

-
localRequestHandler?: any

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

localRequestHandler?: any

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

-
messageEmitters: any

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

messageEmitters: any

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

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

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

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

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

MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

TODO: Is this necessary?

-

Type declaration

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

onMessage: any

Receives and appropriately publishes server webSocket messages

+

Type declaration

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

onMessage: any

Receives and appropriately publishes server webSocket messages

Param: event

WebSocket message information

Param: fromSelf

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

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

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

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

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

Type declaration

Param: requestType

The type of request

Param: contents

Contents to send in the request

Returns

Promise that resolves with the response message

-
requestRouter?: any

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

requestRouter?: any

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

-
requests: any

All requests that are waiting for a response

-
sendMessage: any

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

+
requests: any

All requests that are waiting for a response

+
sendMessage: any

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

Param: message

Message to send

-
subscribe: any

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

+
subscribe: any

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

Param: messageType

The type of message on which to subscribe the function

Param: callback

Function to run with the contents of the webSocket message

Returns

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

-
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-
unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

-
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

-
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

-
webSocket?: any

The webSocket connected to the server

-

Generated using TypeDoc

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

Function that removes this handleEvent from the connection

+
unsubscribeHandleInitClientMessage?: any

Function that removes this initClient handler from the connection

+
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from the connection

+
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from the connection

+
webSocket?: any

The webSocket connected to the server

+

Generated using TypeDoc

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

Handles the endpoint and connections from the server to the clients

-

Implements

Constructors

Implements

Constructors

Properties

clientSockets: any

The webSocket clients that are connected and information about them

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

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

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

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

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

    Param: localEventHandler

    Function that handles events from the server

    Param: networkConnectorEventHandlers

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

    Returns

    Promise that resolves with connector info when finished connecting

    -
connectPromise?: any

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

connectPromise?: any

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

-
connectionStatus: ConnectionStatus

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

connectionStatus: ConnectionStatus

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

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

Information about the connector. Populated by the server while connecting

-

Type declaration

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

Disconnects from the connection:

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

Information about the connector. Populated by the server while connecting

+

Type declaration

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

Disconnects from the connection:

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

Type declaration

    • (): void
    • Returns void

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

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

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

Type declaration

    • (): void
    • Returns void

disconnectClient: any

Closes connection and unregisters a client webSocket when it has disconnected

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

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

Type declaration

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

      • T

      Parameters

      Returns Promise<void>

Param: eventType

Unique network event type for coordinating between processes

Param: event

Event to emit on the network

-
getClientIdFromSocket: any

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

-
getClientSocket: any

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

-
getClientSocketFromGuid: any

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

getClientIdFromSocket: any

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

+
getClientSocket: any

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

+
getClientSocketFromGuid: any

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

-
handleClientConnectMessage: any

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

handleClientConnectMessage: any

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

Param: clientConnect

Message from the client about the connection

Param: connectorId

ClientId of the client who is sending this ClientConnect message

-
handleEventMessage: any

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

handleEventMessage: any

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

Param: eventMessage

Event message to handle

-
handleRequestMessage: any

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

handleRequestMessage: any

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

Param: requestMessage

Request to handle

Param: requesterId

Who sent this message

-
handleResponseMessage: any

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

handleResponseMessage: any

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

Param: response

Response message to resolve

Param: responderId

Responding client

-
localEventHandler?: any

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

localEventHandler?: any

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

-
localRequestHandler?: any

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

localRequestHandler?: any

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

-
messageEmitters: any

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

messageEmitters: any

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

-
networkConnectorEventHandlers?: any

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

-
nextClientId: any

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

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

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

+
networkConnectorEventHandlers?: any

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

+
nextClientId: any

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

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

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

MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

TODO: Is this necessary?

-

Type declaration

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

onClientConnect: any

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

Type declaration

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

onClientConnect: any

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

-
onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

-
onMessage: any

Receives and appropriately publishes webSocket messages

+
onClientDisconnect: any

Handles when client connection disconnects. Unregisters and such

+
onMessage: any

Receives and appropriately publishes webSocket messages

Param: event

WebSocket message information

Param: fromSelf

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

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

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

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

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

Type declaration

Param: requestType

The type of request

Param: contents

Contents to send in the request

Returns

Promise that resolves with the response message

-
requestRouter?: any

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

requestRouter?: any

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

-
requests: any

All requests that are waiting for a response

-
sendMessage: any

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

+
requests: any

All requests that are waiting for a response

+
sendMessage: any

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

Param: message

Message to send

Param: recipientId

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

-
subscribe: any

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

+
subscribe: any

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

Param: messageType

The type of message on which to subscribe the function

Param: callback

Function to run with the contents of the webSocket message

Returns

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

-
unsubscribeHandleClientConnectMessage?: any

Function that removes this clientConnect handler from connections

-
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

-
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

-
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

-
webSocketServer?: any

The webSocket connected to the server

-

Generated using TypeDoc

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

Function that removes this clientConnect handler from connections

+
unsubscribeHandleEventMessage?: any

Function that removes this handleEvent from the connection

+
unsubscribeHandleRequestMessage?: any

Function that removes this handleRequest from connections

+
unsubscribeHandleResponseMessage?: any

Function that removes this response handler from connections

+
webSocketServer?: any

The webSocket connected to the server

+

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html index 01365fdb07..15e657c5e7 100644 --- a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html +++ b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html @@ -1,7 +1,7 @@ ExecutionToken | papi-dts

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

-

Constructors

Constructors

Properties

Methods

Constructors

Properties

name: string
nonce: string
type: "extension"

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

name: string
nonce: string
type: "extension"

Methods

Generated using TypeDoc

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

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

-

Implements

Constructors

Implements

  • WebSocket

Constructors

Properties

Constructors

Properties

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

Type declaration

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

      • K extends keyof WebSocketEventMap

      Parameters

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

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

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

Type declaration

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

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

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

Type declaration

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

      • K extends keyof WebSocketEventMap

      Parameters

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

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

send: ((data) => void)

Type declaration

    • (data): void
    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url: string

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

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

Type declaration

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

      • K extends keyof WebSocketEventMap

      Parameters

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

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

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

Type declaration

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

      • Optional code: number
      • Optional reason: string

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: CloseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: MessageEvent<any>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WebSocket
      • ev: Event

      Returns any

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

Type declaration

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

      • K extends keyof WebSocketEventMap

      Parameters

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

            • this: WebSocket
            • ev: WebSocketEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

send: ((data) => void)

Type declaration

    • (data): void
    • Parameters

      • data: string | ArrayBufferLike | ArrayBufferView | Blob

      Returns void

url: string

Generated using TypeDoc

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

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

-

Implements

Constructors

Implements

  • XMLHttpRequest

Constructors

Properties

Constructors

Properties

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

Type declaration

    • (): void
    • Returns void

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

Type declaration

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

      • K extends keyof XMLHttpRequestEventMap

      Parameters

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

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders: (() => string)

Type declaration

    • (): string
    • Returns string

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

Type declaration

    • (name): null | string
    • Parameters

      • name: string

      Returns null | string

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

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

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

      Returns void

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void
    • Parameters

      • mime: string

      Returns void

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

Type declaration

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

      • K extends keyof XMLHttpRequestEventMap

      Parameters

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

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

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

Type declaration

    • (body?): void
    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

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

Type declaration

    • (name, value): void
    • Parameters

      • name: string
      • value: string

      Returns void

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

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

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

Type declaration

    • (): void
    • Returns void

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

Type declaration

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

      • K extends keyof XMLHttpRequestEventMap

      Parameters

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

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders: (() => string)

Type declaration

    • (): string
    • Returns string

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

Type declaration

    • (name): null | string
    • Parameters

      • name: string

      Returns null | string

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

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

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

      Returns void

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void
    • Parameters

      • mime: string

      Returns void

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

Type declaration

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

      • K extends keyof XMLHttpRequestEventMap

      Parameters

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

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

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

Type declaration

    • (body?): void
    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

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

Type declaration

    • (name, value): void
    • Parameters

      • name: string
      • value: string

      Returns void

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

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html index c24cfd65f8..44f2717222 100644 --- a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html +++ b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html @@ -7,7 +7,7 @@

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

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

-

Type Parameters

Hierarchy

Constructors

Type Parameters

  • T

Hierarchy

  • PlatformEventEmitter<T>
    • default

Constructors

Properties

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

Constructors

Properties

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

Type declaration

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

emit: ((event) => void)

Type declaration

    • (event): void
    • Parameters

      • event: T

      Returns void

networkDisposer: any

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

-
networkSubscriber: any

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

-
subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+
    • (): void
    • Returns void

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

Properties

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

Type declaration

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

emit: ((event) => void)

Type declaration

    • (event): void
    • Parameters

      • event: T

      Returns void

networkDisposer: any

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

+
networkSubscriber: any

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

+
subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

Param: callback

Function to run with the event when it is emitted

Returns

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

Alias

event

-

Accessors

Accessors

Methods

Methods

Generated using TypeDoc

\ No newline at end of file +

Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/classes/_shared_services_data_provider_service_.DataProviderEngine.html b/papi-dts/classes/_shared_services_data_provider_service_.DataProviderEngine.html index 48ab8e8c1f..d6cc334abe 100644 --- a/papi-dts/classes/_shared_services_data_provider_service_.DataProviderEngine.html +++ b/papi-dts/classes/_shared_services_data_provider_service_.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

Constructors

Type Parameters

Constructors

Properties

Constructors

Properties

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

Generated using TypeDoc

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

Type of file system item in a directory

-

Enumeration Members

Enumeration Members

Enumeration Members

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

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

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

Generated using TypeDoc

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

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

-

Enumeration Members

Enumeration Members

Enumeration Members

Connected: 2

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

-
Connecting: 1

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

-
Disconnected: 0

This connector is not connected to the network

-

Generated using TypeDoc

\ No newline at end of file +
Connecting: 1

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

+
Disconnected: 0

This connector is not connected to the network

+

Generated using TypeDoc

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

WebSocket message type that indicates how to handle it

-

Enumeration Members

Enumeration Members

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

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

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

Generated using TypeDoc

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

Type of Paranext process

-

Enumeration Members

Enumeration Members

Enumeration Members

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

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

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

Generated using TypeDoc

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

The type of code that defines a webview's content

-

Enumeration Members

Enumeration Members

Enumeration Members

HTML: "html"

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

-
React: "react"

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

React: "react"

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

-
URL: "url"

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

URL: "url"

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

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

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

Enumeration RequestHandlerType

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

-

Enumeration Members

Enumeration Members

Enumeration Members

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

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

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

Generated using TypeDoc

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

    -

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

  • This is just an alias for internet.fetch

    -

    Parameters

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

    Returns Promise<Response>

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

    Returns Promise<Response>

  • Generated using TypeDoc

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

      -

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    • This is just an alias for internet.fetch

      -

      Parameters

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

      Returns Promise<Response>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

    Returns Promise<Response>

  • Generated using TypeDoc

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

      Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Generated using TypeDoc

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

      -

      Parameters

      • urisPerExtension: Map<string, string>

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

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

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

    -
  • Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

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

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves once the directory has been created

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves when the delete operation finishes

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Parameters

      • uri: string

        URI of file

      Returns Promise<void>

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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html index 73555a0774..c5aa11b347 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<BigIntStats | undefined>

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html index 94f79b5881..0c31bc03a8 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<DirectoryEntries>

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Parameters

      • uri: string

        URI of file or directory

      • date: Date

      Returns Promise<void>

      Promise that resolves once the touch operation finishes

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Parameters

    Returns Promise<void>

    Promise that resolves after writing the file

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index 463d4d574b..932cef4c20 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html @@ -1,4 +1,4 @@ createNonce | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Generated using TypeDoc

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

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

      When packaged: <user_home_directory>/.platform.bible

      -

      Parameters

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

      Returns string

    Properties

    Parameters

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

    Returns string

    Properties

    Properties

    clear: (() => void)

    Type declaration

      • (): void
      • Returns void

    Generated using TypeDoc

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

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Parameters

    Returns Uri

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html index 2d9e019c09..7fba8d1ab8 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns UseDataHookGeneric<TUseDataProviderParams>

    useData hook for getting data from a data provider

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

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

    A function that takes in a networkObjectSource and returns a NetworkObject

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Type Parameters

    Parameters

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Generated using TypeDoc

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

    Returns undefined | DataProviders[DataProviderName]

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

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

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html index 09c77de80f..676a111f73 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 @@ -27,4 +27,4 @@ data provider's subscribe<data_type> method as soon as possible and will not be updated again until projectDataProviderSource or selector changes.

    @returns [data, setData, isLoading]

    -

    Type Parameters

    Parameters

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Generated using TypeDoc

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

    Returns undefined | ProjectDataProviders[ProjectType]

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html index 964d9b1497..8d8b7f4fd5 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 @@ -20,4 +20,4 @@

    Throws

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      -

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_command_service_.addThree.html b/papi-dts/functions/_shared_services_command_service_.addThree.html index 695ff64148..4237df6876 100644 --- a/papi-dts/functions/_shared_services_command_service_.addThree.html +++ b/papi-dts/functions/_shared_services_command_service_.addThree.html @@ -1 +1 @@ -addThree | papi-dts

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Type Parameters

    Parameters

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

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      -

      Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

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

    Function to run when the command is invoked

  • Returns Promise<UnsubscriberAsync>

    True if successfully registered, throws with error message if not

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_connection_service_.connect.html b/papi-dts/functions/_shared_services_connection_service_.connect.html index 318ebf1b94..617e1f81a7 100644 --- a/papi-dts/functions/_shared_services_connection_service_.connect.html +++ b/papi-dts/functions/_shared_services_connection_service_.connect.html @@ -8,4 +8,4 @@
  • connectorEventHandlers: NetworkConnectorEventHandlers

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

  • Returns Promise<void>

    Promise that resolves when finished connecting

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns number

    Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Promise<ComplexResponse<TReturn>>

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Type Parameters

      Parameters

      • providerName: string

        Name of the desired data provider

      Returns Promise<T | undefined>

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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

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

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Name of the service to show in the log

  • Optional tag: string

    Optional tag at the end of the service name

  • Returns string

    Formatted string of a service message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      -

      Parameters

      Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

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

      -

      Parameters

      • callback: PlatformEventHandler<string>

      Returns Unsubscriber

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

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

      -

      Parameters

      • objectToMutate: IDisposableObject
      • newDispose: UnsubscriberAsync

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

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

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

    Type Parameters

    Parameters

    Returns PlatformEventEmitter<T>

    Event emitter whose event works between connections

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Type Parameters

    Parameters

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

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Type Parameters

      • T

      Parameters

      • eventType: string

        Unique network event type for coordinating between connections

      Returns PlatformEvent<T>

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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    Generated using TypeDoc

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

    Returns Promise<UnsubscriberAsync>

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

    -
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Generated using TypeDoc

    \ No newline at end of file +
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Promise<TReturn>

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index 17f98a8d46..26b56d5811 100644 --- a/papi-dts/functions/_shared_services_network_service_.shutdown.html +++ b/papi-dts/functions/_shared_services_network_service_.shutdown.html @@ -1,2 +1,2 @@ shutdown | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

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

    Returns Promise<ProjectDataProviders[ProjectType]>

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

    Example

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Type Parameters

    Parameters

    Returns Promise<Dispose>

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Returns boolean

      Returns true if running on a client, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Returns boolean

      Returns true if running on the extension host, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Returns boolean

      Returns true if running on the renderer, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

      Returns boolean

      Returns true if running on the server, false otherwise

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Promise that resolves when the service is finished initializing

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

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns RequestType

    Generated using TypeDoc

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

      Parameters

      • moduleName: string

        Name of required module that was rejected

      Returns string

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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index 2ed21cbf67..11693726fc 100644 --- a/papi-dts/functions/_shared_utils_util_.newNonce.html +++ b/papi-dts/functions/_shared_utils_util_.newNonce.html @@ -3,4 +3,4 @@

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

    -

    Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html index 954703fec5..9fb7dcace9 100644 --- a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html @@ -2,4 +2,4 @@

    Parameters

    Returns SerializedRequestType

    Full requestType for use in network calls

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Function getWebViewDefinitionUpdatableProperties

    Generated using TypeDoc

    \ No newline at end of file +

    Returns undefined | WebViewDefinitionUpdatableProperties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html b/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html index 69e9592f3b..9ea5643484 100644 --- a/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html +++ b/papi-dts/functions/getWebViewDefinitionUpdatablePropertiesById.html @@ -1 +1 @@ -getWebViewDefinitionUpdatablePropertiesById | papi-dts

    Function getWebViewDefinitionUpdatablePropertiesById

    Generated using TypeDoc

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

    Function getWebViewDefinitionUpdatablePropertiesById

    Generated using TypeDoc

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

    Function getWebViewState

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • defaultValue: T

      Returns T

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T

    Generated using TypeDoc

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

    Function resetWebViewState

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

      -

      Parameters

      • stateKey: string

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 337dac1d5d..9c1b985f84 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    Function setWebViewState

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

      -

      Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index 52e8c219b1..8e52e7f0ca 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -5,4 +5,4 @@

    @example

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

    Parameters

    Returns boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns boolean

    Generated using TypeDoc

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

    Function updateWebViewDefinitionById

    Generated using TypeDoc

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

    Function updateWebViewDefinitionById

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index c7ffaf3743..3190801fb3 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -24,4 +24,4 @@

    @example

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

    Type Parameters

    Parameters

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Generated using TypeDoc

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

    Function webViewComponent

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

      -

      Parameters

      Returns ReactNode

    Properties

    Parameters

    Returns ReactNode

    Properties

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

    Interface for all extensions to implement

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

    Properties

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

    Properties

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

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

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

    Parameters

    Returns Promise<void>

    Param: context

    Data and utilities that are specific to this particular extension

    -
    deactivate?: UnsubscriberAsync

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

    deactivate?: UnsubscriberAsync

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

    Returns

    Promise that resolves to true if successfully deactivated

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Properties

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

    Properties

    Parameters

    • token: ExecutionToken

      ExecutionToken provided to the extension when activate() was called

    • key: string

      Unique identifier of the data

    Returns Promise<void>

    Promise that will resolve if the data is deleted successfully

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

    Type declaration

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

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

    Type declaration

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

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<Buffer>

        Promise for a Buffer with the contents of the file

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

    Type declaration

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

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

    Type declaration

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

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<string>

        Promise for a string with the contents of the file

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

    Type declaration

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

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

    Type declaration

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

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        Returns Promise<string>

        Promise for a string containing the data

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

    Type declaration

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

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

    Type declaration

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

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        • data: string

          Data to be written

        Returns Promise<void>

        Promise that will resolve if the data is written successfully

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Example

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

    Properties

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

    Properties

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

    Type declaration

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

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

    Type declaration

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

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

    Type declaration

      • (...nums): number
      • Parameters

        • Rest ...nums: number[]

        Returns number

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

    Type declaration

      • (message): string
      • Parameters

        • message: string

        Returns string

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

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

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

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

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

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

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

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

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

    Type declaration

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

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

    Type declaration

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

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

    Type declaration

      • (...nums): number
      • Parameters

        • Rest ...nums: number[]

        Returns number

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

    Type declaration

      • (message): string
      • Parameters

        • message: string

        Returns string

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

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

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

    Type declaration

      • (message): Promise<string>
      • Parameters

        • message: string

        Returns Promise<string>

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

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

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

    Type declaration

      • (message): void
      • Parameters

        • message: string

        Returns void

    Generated using TypeDoc

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

    Example

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

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

    export type PeopleDataProvider = IDataProvider<PeopleDataTypes> & PeopleDataMethods;

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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html index 9639f1fb73..c904651ad7 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html @@ -10,6 +10,6 @@ MyExtensionProjectTypeName data provider types):

    Example

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

    export interface ProjectDataProviders {
    MyExtensionProjectTypeName: IDataProvider<MyProjectDataType>;
    }
    }
    -
    interface ProjectDataProviders {
        platform.notesOnly: "shared/models/data-provider.interface".default<MandatoryProjectDataType & {
            Notes: DataProviderDataType<string, undefined | string, string>;
        }>;
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes & MandatoryProjectDataType>;
    }

    Properties

    Properties

    platform.notesOnly: "shared/models/data-provider.interface".default<MandatoryProjectDataType & {
        Notes: DataProviderDataType<string, undefined | string, string>;
    }>

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    platform.notesOnly: "shared/models/data-provider.interface".default<MandatoryProjectDataType & {
        Notes: DataProviderDataType<string, undefined | string, string>;
    }>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 0421aea41f..06917fa75d 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -1,3 +1,3 @@ -SettingTypes | papi-dts
    interface SettingTypes {
        placeholder: undefined;
        platform.verseRef: ScriptureReference;
    }

    Properties

    placeholder +SettingTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    placeholder: undefined
    platform.verseRef: ScriptureReference

    Generated using TypeDoc

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

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

    Keys should be dialog names, and values should be DialogDataTypes

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

    -

    Properties

    Properties

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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

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

    Generated using TypeDoc

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

    Information about a floating window

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

    Properties

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

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -
    type: "float"

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +
    type: "float"

    Generated using TypeDoc

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

    Information about a panel

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

    Properties

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

    Properties

    direction?: PanelDirection
    targetTabId?: string

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

    -
    type: "panel"

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction?: PanelDirection
    targetTabId?: string

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

    +
    type: "panel"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html index 6aa185982e..707bc2eed8 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html @@ -1,3 +1,3 @@ TabLayout | papi-dts

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type: "tab"

    Generated using TypeDoc

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

    Properties

    Properties

    type: "tab"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html index 07b2e8ad10..1d8754fc93 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineFactory.html @@ -1,2 +1,2 @@ -ProjectDataProviderEngineFactory | papi-dts
    interface ProjectDataProviderEngineFactory<ProjectType> {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    Generated using TypeDoc

    \ No newline at end of file +ProjectDataProviderEngineFactory | papi-dts
    interface ProjectDataProviderEngineFactory<ProjectType> {
        createProjectDataProviderEngine(projectId, projectStorageInterpreterId): ProjectDataProviderEngineTypes[ProjectType];
    }

    Type Parameters

    Methods

    Generated using TypeDoc

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

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

    See

    networkObjectService

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    Methods

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

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

    Generated using TypeDoc

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

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

    See

    networkObjectService

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    See

    networkObjectService

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    Methods

    Properties

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Properties

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

    Properties

    decorators: {
        ignore: {
            (method): void;
            <T>(target, member): void;
        };
    }

    Type declaration

    • ignore: {
          (method): void;
          <T>(target, member): void;
      }
        • (method): void
        • Decorator function that marks a data provider engine set___ or get___ method to be ignored. +

    Properties

    decorators: {
        ignore: {
            (method): void;
            <T>(target, member): void;
        };
    }

    Type declaration

    • ignore: {
          (method): void;
          <T>(target, member): void;
      }
        • (method): void
        • Decorator function that marks a data provider engine set___ or get___ method to be ignored. papi will not layer over these methods or consider them to be data type methods

          Parameters

          • method: Function & {
                isIgnored?: boolean;
            }

            The method to ignore

          Returns void

          Example: Use this as a decorator on a class's method:

          class MyDataProviderEngine {
          papi.dataProviders.decorators.ignore
          async getInternal() {}
          } @@ -20,13 +20,13 @@

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

        • member: keyof T

          The name of the method to ignore

          Note: this is the signature that provides the actual decorator functionality. However, since users will not be using this signature, the example usage is provided in the signature above.

          -

    Returns void

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

    Type declaration

    Returns void

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

    Type declaration

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

        Type Parameters

        • DataProviderName extends keyof DataProviders

        Parameters

        Returns Promise<DataProviders[DataProviderName] | undefined>

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

        -
    hasKnown: ((providerName) => boolean)

    Type declaration

      • (providerName): boolean
      • Indicate if we are aware of an existing data provider with the given name. If a data provider +

    hasKnown: ((providerName) => boolean)

    Type declaration

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

        -

        Parameters

        • providerName: string

        Returns boolean

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

    Type declaration

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

        Parameters

        • providerName: string

        Returns boolean

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

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Prompt the user for responses with dialogs

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

    Methods

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

    Methods

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

      Parameters

      • Optional options: DialogOptions

        Various options for configuring the dialog that shows

      Returns Promise<undefined | string>

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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Properties

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

    Properties

    Properties

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

    Type declaration

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

        • input: RequestInfo | URL
        • Optional init: RequestInit

        Returns Promise<Response>

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

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

        Returns Promise<Response>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • input: RequestInfo | URL
    • Optional init: RequestInit

    Returns Promise<Response>

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

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

    Returns Promise<Response>

  • Generated using TypeDoc

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

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

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

    Implemented by

    Properties

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

    Implemented by

    Properties

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

    Param: localEventHandler

    Function that handles events from the server

    Param: networkConnectorEventHandlers

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

    Returns

    Promise that resolves with connector info when finished connecting

    -
    connectionStatus: ConnectionStatus

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

    connectionStatus: ConnectionStatus

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

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

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

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

    Disconnects from the connection:

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

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

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

    Disconnects from the connection:

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

      Returns

      Promise that resolves with connector info when finished conne

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

    Returns void

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

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

    Returns void

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

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

    Type declaration

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

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

        Returns

        Promise that resolves with connector info when finished conne

      • event: InternalEvent<T>

        Event to emit on the network

    Returns Promise<void>

    Param: eventType

    Unique network event type for coordinating between processes

    Param: event

    Event to emit on the network

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

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

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

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

    MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

    TODO: Is this necessary?

    Type declaration

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

        MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

        TODO: Is this necessary?

        -

        Returns Promise<void>

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

    +

    Returns Promise<void>

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

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

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

    Get details about all available network objects

    Type declaration

    Returns

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Provides functions related to the set of available network objects

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

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

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

    Get details about all available network objects

    Type declaration

    Returns

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

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

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

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

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

    Type declaration

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

        Parameters

        • id: string
        • Optional timeoutInMS: number

        Returns Promise<NetworkObjectDetails>

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

    Returns

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Properties

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

    Properties

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

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

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between connections

    Returns PlatformEventEmitter<T>

    Event emitter whose event works between connections

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

    Type declaration

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

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

    Type declaration

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

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between connections

        Returns PlatformEvent<T>

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

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

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Properties

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

    Properties

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

    Type declaration

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

        Type Parameters

        Parameters

        • projectType: ProjectType

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

        Returns Promise<ProjectDataProviders[ProjectType]>

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

        Example

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

    Type declaration

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

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

    Type declaration

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

        Type Parameters

        Parameters

        Returns Promise<Dispose>

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

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Properties

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

    Properties

    Properties

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

    Type declaration

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

        Type Parameters

        Parameters

        • projectType: ProjectType

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

        Returns Promise<ProjectDataProviders[ProjectType]>

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

        Example

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Provides metadata for projects known by the platform

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

    Properties

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

    Properties

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

    Provide metadata for all projects found on the local system

    Type declaration

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

        Returns Promise<ProjectMetadata[]>

        ProjectMetadata for all projects stored on the local system

    Returns

    ProjectMetadata for all projects stored on the local system

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

    Look up metadata for a specific project ID

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

    Look up metadata for a specific project ID

    Type declaration

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

        Parameters

        • projectId: string

          ID of the project to load

        Returns Promise<ProjectMetadata>

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

    Param: projectId

    ID of the project to load

    Returns

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html b/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html index 742675d907..a7cc7b7a14 100644 --- a/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html +++ b/papi-dts/interfaces/_shared_services_settings_service_.SettingsService.html @@ -1,4 +1,4 @@ -SettingsService | papi-dts
    interface SettingsService {
        get: (<SettingName>(key, defaultSetting) => SettingTypes[SettingName]);
        reset: (<SettingName>(key) => void);
        set: (<SettingName>(key, newSetting) => void);
        subscribe: (<SettingName>(key, callback) => Unsubscriber);
    }

    Properties

    get +SettingsService | papi-dts
    interface SettingsService {
        get: (<SettingName>(key, defaultSetting) => SettingTypes[SettingName]);
        reset: (<SettingName>(key) => void);
        set: (<SettingName>(key, newSetting) => void);
        subscribe: (<SettingName>(key, callback) => Unsubscriber);
    }

    Properties

    get reset set subscribe @@ -7,15 +7,15 @@
  • defaultSetting: SettingTypes[SettingName]

    The default value used for the setting if no value is available for the key

  • Returns SettingTypes[SettingName]

    The value of the specified setting, parsed to an object. Returns default setting if setting does not exist

    -
    reset: (<SettingName>(key) => void)

    Type declaration

      • <SettingName>(key): void
      • Removes the setting from memory

        +
    reset: (<SettingName>(key) => void)

    Type declaration

      • <SettingName>(key): void
      • Removes the setting from memory

        Type Parameters

        Parameters

        • key: SettingName

          The string id of the setting for which the value is being removed

          -

        Returns void

    set: (<SettingName>(key, newSetting) => void)

    Type declaration

      • <SettingName>(key, newSetting): void
      • Sets the value of the specified setting

        +

    Returns void

    set: (<SettingName>(key, newSetting) => void)

    Type declaration

      • <SettingName>(key, newSetting): void
      • Sets the value of the specified setting

        Type Parameters

        Parameters

        • key: SettingName

          The string id of the setting for which the value is being retrieved

        • newSetting: SettingTypes[SettingName]

          The value that is to be stored. Setting the new value to undefined is the equivalent of deleting the setting

          -

        Returns void

    subscribe: (<SettingName>(key, callback) => Unsubscriber)

    Type declaration

      • <SettingName>(key, callback): Unsubscriber
      • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the +

    Returns void

    subscribe: (<SettingName>(key, callback) => Unsubscriber)

    Type declaration

      • <SettingName>(key, callback): Unsubscriber
      • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the callback function is executed.

        Type Parameters

        Parameters

        • key: SettingName

          The string id of the setting for which the value is being subscribed to

        • callback: ((newSetting) => void)

          The function that will be called whenever the specified setting is updated

        Returns Unsubscriber

        Unsubscriber that should be called whenever the subscription should be deleted

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Properties

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

    Properties

    Properties

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

    Type declaration

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

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

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

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Properties

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

    Properties

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

    Type declaration

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

        Parameters

        • webViewType: string

          Type of webview provider to get

        Returns Promise<WebViewProvider | undefined>

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

        -
    hasKnown: ((webViewType) => boolean)

    Type declaration

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

    hasKnown: ((webViewType) => boolean)

    Type declaration

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

        Parameters

        • webViewType: string

          Type of webView to check for

          -

        Returns boolean

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

    Type declaration

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

        -

        Returns Promise<void>

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

    Type declaration

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

        +

    Returns boolean

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

    Type declaration

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

        +

        Returns Promise<void>

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

    Type declaration

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

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

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

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<DisposableWebViewProvider>

        webViewProvider modified to be a network object

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Service exposing various functions related to using webViews

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

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

    Properties

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

    Properties

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

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

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

    Param: options

    Options that affect what this function does. For examp

    Returns

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

    Throws

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

    -
    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -

    Generated using TypeDoc

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

    Event that emits with webView info when a webView is added

    +

    Generated using TypeDoc

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

    Namespace "@papi/backend"

    Index

    Variables

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

    Namespace "@papi/backend"

    Index

    Variables

    DataProviderEngine commands dataProviders default diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index cb06bc5c7f..262a5acb88 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 cde144327e..31305caa42 100644 --- a/papi-dts/modules/__papi_frontend_.html +++ b/papi-dts/modules/__papi_frontend_.html @@ -1,4 +1,4 @@ -"@papi/frontend" | papi-dts

    Namespace "@papi/frontend"

    Index

    Type Aliases

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

    Namespace "@papi/frontend"

    Index

    Type Aliases

    Variables

    WebSocket XMLHttpRequest commands diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index 0965872aca..6cf1b4a122 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 fa7a3c0c23..59f1fdc043 100644 --- a/papi-dts/modules/_client_services_client_network_connector_service_.html +++ b/papi-dts/modules/_client_services_client_network_connector_service_.html @@ -1,2 +1,2 @@ -"client/services/client-network-connector.service" | papi-dts

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

    Index

    Classes

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

    Generated using TypeDoc

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

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

    Generated using TypeDoc

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

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

    Index

    Interfaces

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

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

    Generated using TypeDoc

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

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

    Index

    Namespaces

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

    Generated using TypeDoc

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

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    Variables

    Functions

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

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

    Index

    Classes

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

    Generated using TypeDoc

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

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

    Index

    Classes

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

    Generated using TypeDoc

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

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

    Index

    Variables

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

    Generated using TypeDoc

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

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

    Index

    Enumerations

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

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

    Index

    Enumerations

    Type Aliases

    Functions

    copyFile createDir diff --git a/papi-dts/modules/_node_utils_crypto_util_.html b/papi-dts/modules/_node_utils_crypto_util_.html index 68a4ebf397..0dcf6f3196 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,3 +1,3 @@ -"node/utils/crypto-util" | papi-dts

    Namespace "node/utils/crypto-util"

    Index

    Functions

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_node_utils_util_.html b/papi-dts/modules/_node_utils_util_.html index 8af8778722..2fd8169d1f 100644 --- a/papi-dts/modules/_node_utils_util_.html +++ b/papi-dts/modules/_node_utils_util_.html @@ -1,4 +1,4 @@ -"node/utils/util" | papi-dts

    Namespace "node/utils/util"

    Index

    Variables

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

    Namespace "node/utils/util"

    Index

    Variables

    Functions

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

    Namespace "papi-shared-types"

    Index

    Interfaces

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

    Namespace "papi-shared-types"

    Index

    Interfaces

    CommandHandlers DataProviders ProjectDataProviders SettingTypes 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 6973ad038f..9d4d1a78d5 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-base.data" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    Variables

    Functions

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

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    Type Aliases

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

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Functions

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index a95bb193b2..6c333a19fa 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 656798e557..a2d7828da1 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

    Generated using TypeDoc

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

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Classes

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

    Generated using TypeDoc

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

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

    Index

    Classes

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

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

    Generated using TypeDoc

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

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

    Index

    Enumerations

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

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

    Index

    Enumerations

    Type Aliases

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

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

    Index

    Enumerations

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

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

    Index

    Enumerations

    Type Aliases

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

    Namespace "shared/global-this.model"

    Index

    Enumerations

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_data_provider_engine_model_.html index 1012776cf1..5723bf49ed 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

    Type Aliases

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index 7b962ce562..966b1122d5 100644 --- a/papi-dts/modules/_shared_models_data_provider_interface_.html +++ b/papi-dts/modules/_shared_models_data_provider_interface_.html @@ -1,3 +1,3 @@ -"shared/models/data-provider.interface" | papi-dts

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

    Index

    Type Aliases

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index 36cbb0772f..edf1e81f2c 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 aa6b7d5d2d..ba91dd5368 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,3 +1,3 @@ -"shared/models/dialog-options.model" | papi-dts

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

    Index

    Type Aliases

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

    Generated using TypeDoc

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

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    Type Aliases

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

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

    Index

    Type Aliases

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

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

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

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

    Index

    Classes

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

    Generated using TypeDoc

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

    Interfaces

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_model_.html b/papi-dts/modules/_shared_models_project_data_provider_model_.html index 5f5fe74854..b49c2a8492 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider.model" | papi-dts

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

    Index

    Type Aliases

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index fe167354a0..3aa0f06035 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,2 +1,2 @@ -"shared/models/project-metadata.model" | papi-dts

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

    Index

    Type Aliases

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index a07817ff6f..d3d2e27631 100644 --- a/papi-dts/modules/_shared_models_web_view_model_.html +++ b/papi-dts/modules/_shared_models_web_view_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view.model" | papi-dts

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

    Index

    Enumerations

    WebViewContentType +"shared/models/web-view.model" | papi-dts

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

    Index

    Enumerations

    Type Aliases

    GetWebViewDefinitionUpdatableProperties GetWebViewOptions SavedWebViewDefinition diff --git a/papi-dts/modules/_shared_models_web_view_provider_model_.html b/papi-dts/modules/_shared_models_web_view_provider_model_.html index 95e624c7d7..778d814d1a 100644 --- a/papi-dts/modules/_shared_models_web_view_provider_model_.html +++ b/papi-dts/modules/_shared_models_web_view_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view-provider.model" | papi-dts

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

    Index

    Interfaces

    DisposableWebViewProvider +"shared/models/web-view-provider.model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index c5e9366c3d..1344d37572 100644 --- a/papi-dts/modules/_shared_services_command_service_.html +++ b/papi-dts/modules/_shared_services_command_service_.html @@ -1,4 +1,4 @@ -"shared/services/command.service" | papi-dts

    Namespace "shared/services/command.service"

    Index

    Type Aliases

    moduleSummaryComments +"shared/services/command.service" | papi-dts

    Namespace "shared/services/command.service"

    Index

    Type Aliases

    Functions

    addThree createSendCommandFunction initialize diff --git a/papi-dts/modules/_shared_services_connection_service_.html b/papi-dts/modules/_shared_services_connection_service_.html index ee86cad4c8..fd90552f0c 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 376fe1552d..2fdcda98dd 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

    Classes

    DataProviderEngine +"shared/services/data-provider.service" | papi-dts

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

    Index

    Classes

    Interfaces

    Variables

    Functions

    getByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index 5bc85644cc..ff5d575f5b 100644 --- a/papi-dts/modules/_shared_services_dialog_service_.html +++ b/papi-dts/modules/_shared_services_dialog_service_.html @@ -1,2 +1,2 @@ -"shared/services/dialog.service" | papi-dts

    Namespace "shared/services/dialog.service"

    Index

    Variables

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index bb1a8b40cd..a5c8a5ea12 100644 --- a/papi-dts/modules/_shared_services_dialog_service_model_.html +++ b/papi-dts/modules/_shared_services_dialog_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/dialog.service-model" | papi-dts

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

    Index

    Interfaces

    DialogService +"shared/services/dialog.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index f2faef191d..c436f7bfbf 100644 --- a/papi-dts/modules/_shared_services_internet_service_.html +++ b/papi-dts/modules/_shared_services_internet_service_.html @@ -1,3 +1,3 @@ -"shared/services/internet.service" | papi-dts

    Namespace "shared/services/internet.service"

    Index

    Interfaces

    InternetService +"shared/services/internet.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 3e29c0fb67..31513bec9f 100644 --- a/papi-dts/modules/_shared_services_logger_service_.html +++ b/papi-dts/modules/_shared_services_logger_service_.html @@ -1,4 +1,4 @@ -"shared/services/logger.service" | papi-dts

    Namespace "shared/services/logger.service"

    Index

    Variables

    WARN_TAG +"shared/services/logger.service" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_menu_data_service_.html b/papi-dts/modules/_shared_services_menu_data_service_.html index b6e8c87f70..0b269f3e02 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_.html @@ -1,2 +1,2 @@ -"shared/services/menu-data.service" | papi-dts

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

    Index

    Variables

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_menu_data_service_model_.html b/papi-dts/modules/_shared_services_menu_data_service_model_.html index 4166075d01..b6b6c7d985 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_model_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/menu-data.service-model" | papi-dts

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

    Index

    Type Aliases

    IMenuDataService +"shared/services/menu-data.service-model" | papi-dts

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

    Index

    Type Aliases

    Variables

    menuDataServiceObjectToProxy menuDataServiceProviderName diff --git a/papi-dts/modules/_shared_services_network_connector_factory_.html b/papi-dts/modules/_shared_services_network_connector_factory_.html index 24888f29f6..6434bc1082 100644 --- a/papi-dts/modules/_shared_services_network_connector_factory_.html +++ b/papi-dts/modules/_shared_services_network_connector_factory_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.factory" | papi-dts

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

    Index

    Functions

    createNetworkConnector +"shared/services/network-connector.factory" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_connector_interface_.html b/papi-dts/modules/_shared_services_network_connector_interface_.html index e1bb8e0b40..38db8f56d9 100644 --- a/papi-dts/modules/_shared_services_network_connector_interface_.html +++ b/papi-dts/modules/_shared_services_network_connector_interface_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.interface" | papi-dts

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

    Index

    Interfaces

    default +"shared/services/network-connector.interface" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index 0054138763..c163e27383 100644 --- a/papi-dts/modules/_shared_services_network_object_service_.html +++ b/papi-dts/modules/_shared_services_network_object_service_.html @@ -1,4 +1,4 @@ -"shared/services/network-object.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    Functions

    onDidCreateNetworkObject onDidDisposeNetworkObject overrideDispose diff --git a/papi-dts/modules/_shared_services_network_object_status_service_.html b/papi-dts/modules/_shared_services_network_object_status_service_.html index b7bb6e7e5e..6cc51d79de 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_.html @@ -1,2 +1,2 @@ -"shared/services/network-object-status.service" | papi-dts

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

    Index

    Variables

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_object_status_service_model_.html b/papi-dts/modules/_shared_services_network_object_status_service_model_.html index 63f124f998..29b3c4ab8c 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/network-object-status.service-model" | papi-dts

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

    Index

    Interfaces

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index 9aef447eae..8ed3d51e9a 100644 --- a/papi-dts/modules/_shared_services_network_service_.html +++ b/papi-dts/modules/_shared_services_network_service_.html @@ -1,4 +1,4 @@ -"shared/services/network.service" | papi-dts

    Namespace "shared/services/network.service"

    Index

    Interfaces

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

    Namespace "shared/services/network.service"

    Index

    Interfaces

    Type Aliases

    ArgsRequestHandler ComplexRequestHandler ContentsRequestHandler diff --git a/papi-dts/modules/_shared_services_project_data_provider_service_.html b/papi-dts/modules/_shared_services_project_data_provider_service_.html index 159aebbca4..0dc2b4d2b0 100644 --- a/papi-dts/modules/_shared_services_project_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_project_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/project-data-provider.service" | papi-dts

    Namespace "shared/services/project-data-provider.service"

    Index

    Interfaces

    PapiBackendProjectDataProviderService +"shared/services/project-data-provider.service" | papi-dts

    Namespace "shared/services/project-data-provider.service"

    Index

    Interfaces

    Variables

    papiBackendProjectDataProviderService papiFrontendProjectDataProviderService diff --git a/papi-dts/modules/_shared_services_project_lookup_service_.html b/papi-dts/modules/_shared_services_project_lookup_service_.html index 2d4a26169b..cce7a528a8 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_lookup_service_model_.html b/papi-dts/modules/_shared_services_project_lookup_service_model_.html index f2f3a8ae83..998e5668fd 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/project-lookup.service-model" | papi-dts

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

    Index

    Interfaces

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index 0b46f0932b..2c376bad28 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Interfaces

    SettingsService +"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Interfaces

    Type Aliases

    ResetSettingEvent SettingEvent UpdateSettingEvent 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 27c583915c..0b8d7ea1dd 100644 --- a/papi-dts/modules/_shared_services_web_view_provider_service_.html +++ b/papi-dts/modules/_shared_services_web_view_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/web-view-provider.service" | papi-dts

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

    Index

    Interfaces

    PapiWebViewProviderService +"shared/services/web-view-provider.service" | papi-dts

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

    Index

    Interfaces

    Variables

    default papiWebViewProviderService diff --git a/papi-dts/modules/_shared_services_web_view_service_.html b/papi-dts/modules/_shared_services_web_view_service_.html index c894e984d5..3886f5cd12 100644 --- a/papi-dts/modules/_shared_services_web_view_service_.html +++ b/papi-dts/modules/_shared_services_web_view_service_.html @@ -1,2 +1,2 @@ -"shared/services/web-view.service" | papi-dts

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

    Index

    Variables

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_web_view_service_model_.html b/papi-dts/modules/_shared_services_web_view_service_model_.html index d9ebc8a73a..6306e29552 100644 --- a/papi-dts/modules/_shared_services_web_view_service_model_.html +++ b/papi-dts/modules/_shared_services_web_view_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/web-view.service-model" | papi-dts

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

    Index

    Interfaces

    WebViewServiceType +"shared/services/web-view.service-model" | papi-dts

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index ded38ab632..60ef560cc8 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 fc57cb7bcd..a86032803d 100644 --- a/papi-dts/modules/_shared_utils_util_.html +++ b/papi-dts/modules/_shared_utils_util_.html @@ -1,4 +1,4 @@ -"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Enumerations

    RequestHandlerType +"shared/utils/util" | papi-dts

    Namespace "shared/utils/util"

    Index

    Enumerations

    Type Aliases

    ComplexRequest ComplexResponse ComplexResponseFailure diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 042face70a..80a473be7e 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html index b0f618129a..ed17dce149 100644 --- a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html +++ b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html @@ -3,4 +3,4 @@ ClientNetworkConnector. For now, we are just using the browser WebSocket type. We may need specific functionality that don't line up between the ws library's implementation and the browser implementation. We can adjust as needed at that point.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html index a7256f89d2..82aef6b3fc 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html +++ b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html @@ -2,4 +2,4 @@

    Type declaration

    • executionToken: ExecutionToken

      Used to save and load data from the storage service.

    • name: string

      Canonical name of the extension

    • registrations: UnsubscriberAsyncList

      Tracks all registrations made by an extension so they can be cleaned up when it is unloaded

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html index 3834cc14fb..d2e6c85861 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html +++ b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html @@ -21,4 +21,4 @@ for more information about extension type declaration files.

  • version: string

    Extension version - expected to be semver like "0.1.3".

    Note: semver may become a hard requirement in the future, so we recommend using it now.

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html index 325149536e..ee280e148d 100644 --- a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html +++ b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html @@ -1,2 +1,2 @@ ExecutionTokenType | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html index 1f91f752a6..ee314408d8 100644 --- a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html +++ b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html @@ -1,2 +1,2 @@ DirectoryEntries | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index 592a44fd82..e65399ee8b 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' commands that are added to CommandHandlers.

    Example

    'platform.quit';
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index eaf0aec87c..85c67a5202 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    'platform.placeholder'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index 68b679c5ff..eb414debb0 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -3,4 +3,4 @@

    Automatically includes all extensions' data providers that are added to DataProviders.

    Example

    DataProviderTypes['helloSomeone.people'] => {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index dd58449fe2..f190ad11f4 100644 --- a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html +++ b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html @@ -2,4 +2,4 @@ returned from papi.dataProviders.registerEngine - only the one who registers a data provider engine is allowed to dispose of the data provider.

    Automatically includes all extensions' data providers that are added to DataProviders.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 4e6ec324bd..ddbf92c839 100644 --- a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html @@ -1,2 +1,2 @@ NotesOnlyProjectDataTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index 3e88b04e9f..6075fde8a4 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html index 505d783f16..e46ec58189 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html @@ -4,4 +4,4 @@ ProjectDataProviders.

    Example

    ProjectDataTypes['MyExtensionProjectTypeName'] => {
    MyProjectData: DataProviderDataType<string, string, string>;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectTypes.html index cde2a31d11..1f43a60fcd 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -3,4 +3,4 @@ ProjectDataProviders.

    Example

    'platform.placeholder'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 725e610a1b..bdae352bf0 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -1 +1 @@ -SettingNames | papi-dts

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index ee7fb5106a..e8473ac3de 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html index ba0fc08da7..773d4d29b1 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html @@ -15,4 +15,4 @@

    TODO: preserve requests between refreshes - save the dialog info in such a way that it works when loading again after refresh

  • Optional tabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html index 16af5bb625..c7aa1eb0cb 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html @@ -1,7 +1,7 @@ DialogProps | papi-dts
    DialogProps<TData>: DialogData & {
        cancelDialog(): void;
        rejectDialog(errorMessage): void;
        submitDialog(data): void;
    }

    Props provided to the dialog component

    Type Parameters

    • TData = unknown

    Type declaration

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

        -

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        Parameters

        • errorMessage: string

          Message to explain why the dialog request was rejected

          -

        Returns void

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

        +

    Returns void

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

      Parameters

      • data: TData

        Data with which to resolve the request

        -

      Returns void

  • Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html index bfe15852fa..d3bdd490f3 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html @@ -5,4 +5,4 @@ as props

  • props: DialogProps<TReturnType> & TOptions

    Props provided to the dialog component

  • responseType: TReturnType

    The type of the response to the dialog request

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html index 501a489a32..b6de515896 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html @@ -1 +1 @@ -DialogDefinition | papi-dts

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html index 74da68f850..124aadb900 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html @@ -1,2 +1,2 @@ DialogTabTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index 03e92d208c..04d4d26543 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,4 +1,4 @@ SelectMultipleProjectsDialogOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html index b7117993ca..85f1e08a95 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,3 +1,3 @@ SelectProjectDialogOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html index d0bfdd1436..3993cc420e 100644 --- a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html +++ b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html @@ -1,4 +1,4 @@ UseDialogCallbackOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_file_system_model_.Uri.html b/papi-dts/types/_shared_data_file_system_model_.Uri.html index adbf16a7dc..ea5848d53c 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -24,4 +24,4 @@

    Note: projects are stored in the production version of app://projects regardless of whether you are in production or development

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html index 4e3293fa70..7b64f2c5c6 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientConnectEvent.html @@ -1,2 +1,2 @@ ClientConnectEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html index f9f2bce8ec..cb3b86df49 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.ClientDisconnectEvent.html @@ -1,2 +1,2 @@ ClientDisconnectEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html index cf86f9c58d..11463a0dfb 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalEvent.html @@ -1,4 +1,4 @@ InternalEvent | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html index 1deabcca70..bfcf3629f0 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalNetworkEventHandler.html @@ -1,3 +1,3 @@ InternalNetworkEventHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

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

        • T

        Parameters

        Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html index b131d9675c..a5372d2e3c 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequest.html @@ -1,2 +1,2 @@ InternalRequest | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html index 650d1f3223..03da04de0c 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalRequestHandler.html @@ -1,3 +1,3 @@ InternalRequestHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html index d5e946420d..9f8fa399d7 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.InternalResponse.html @@ -1,4 +1,4 @@ InternalResponse | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html index 6a8abc28c4..25de61e890 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html @@ -4,4 +4,4 @@
      • (event): void
      • Handles when a new connection is established

        Parameters

        Returns void

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

    Handles when a client disconnects

  • Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html index ab216423f4..bd3688f636 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorInfo.html @@ -1,2 +1,2 @@ NetworkConnectorInfo | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • clientId: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html index 0b9eab2ddd..973d8b9a43 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkEventHandler.html @@ -1,2 +1,2 @@ NetworkEventHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

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

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html index 0132f6bdc7..8bdb5f825a 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestHandler.html @@ -1,2 +1,2 @@ RequestHandler | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html index 87c9f392a3..572501cbb7 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.RequestRouter.html @@ -1,2 +1,2 @@ RequestRouter | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • (requestType): number
      • Parameters

        • requestType: string

        Returns number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html index 225a30b65d..e8c3fd6209 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html +++ b/papi-dts/types/_shared_data_network_connector_model_.ClientConnect.html @@ -3,4 +3,4 @@ (like if the browser refreshes): if the server has a connection with this clientGuid, it will unregister all requests on that client so the reconnecting client can register its request handlers again.

    -
  • senderId: number
  • type: ClientConnect
  • Generated using TypeDoc

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

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html index 71391d033a..fb3e05018d 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.InitClient.html +++ b/papi-dts/types/_shared_data_network_connector_model_.InitClient.html @@ -1,3 +1,3 @@ InitClient | papi-dts

    Generated using TypeDoc

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

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.Message.html b/papi-dts/types/_shared_data_network_connector_model_.Message.html index 8f1d566e49..4b8eace7dc 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.Message.html +++ b/papi-dts/types/_shared_data_network_connector_model_.Message.html @@ -1,2 +1,2 @@ Message | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html index 3df7bf2885..2a250f4848 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketEvent.html @@ -1,3 +1,3 @@ WebSocketEvent | papi-dts

    Generated using TypeDoc

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

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html index 20207ee5c6..f0873f0a57 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketRequest.html @@ -1,3 +1,3 @@ WebSocketRequest | papi-dts

    Generated using TypeDoc

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

    \ No newline at end of file diff --git a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html index b61371afe9..5630a0849a 100644 --- a/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html +++ b/papi-dts/types/_shared_data_network_connector_model_.WebSocketResponse.html @@ -1,3 +1,3 @@ WebSocketResponse | papi-dts

    Generated using TypeDoc

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

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html index 59c863a723..2855099657 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 @@ -17,4 +17,4 @@

    Example: You can log the manual updates in your data provider engine by spec

    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.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html index 27fd66c825..b4add613ef 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 @@ -24,4 +24,4 @@

    See

    DataProviderUpdateInstructions for more info on the updateI

  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html index 1693a8c1ff..a2bede8f07 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 @@
    class MyDPE extends DataProviderEngine<MyDataTypes> implements IDataProviderEngine<MyDataTypes> {
    ...
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html index 9b54ff8bf7..015121d98e 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.default.html b/papi-dts/types/_shared_models_data_provider_interface_.default.html index 8dbd387be1..73e704ac67 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 dataProviderService.get.

    Note: each set<data_type> method has a corresponding get<data_type> and subscribe<data_type> method.

    -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html index c22f24e2c2..d77a83d4b7 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html @@ -7,4 +7,4 @@ wants at this data type.

  • setData: TSetData

    The type of data ingested by this data provider when you run set<data_type> based on a provided selector

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html index 6f5e1a386e..8d21bbdadb 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html @@ -7,4 +7,4 @@ following:

    {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    All: DataProviderDataType<undefined, { greeting: string, age: number }, never>;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html index 50e401ca20..8f7b99825b 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html @@ -4,4 +4,4 @@ up-to-date.

    Type Parameters

    Type declaration

      • (selector): Promise<TDataType["getData"]>
      • Parameters

        • selector: TDataType["selector"]

          Tells the provider what subset of data to get

        Returns Promise<TDataType["getData"]>

    Returns

    The subset of data represented by the selector

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html index 598cdee64c..3b90550788 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html @@ -1,3 +1,3 @@ DataProviderGetters | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html index 9f7d69d62d..56d888a949 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html @@ -6,4 +6,4 @@

    Returns Promise<DataProviderUpdateInstructions<TDataTypes>>

    Returns

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    See

    DataProviderUpdateInstructions for more info on what to return

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html index 3a4fa36e83..8d3d7e590e 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html @@ -1,3 +1,3 @@ DataProviderSetters | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html index 7edda567cc..fdc388e7c8 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html @@ -8,4 +8,4 @@
  • callback: PlatformEventHandler<TDataType["getData"]>

    Function to run with the updated data for this selector

  • Optional options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Returns

    Unsubscriber to stop listening for updates

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html index 696f62fa66..96300fd622 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html @@ -21,4 +21,4 @@

    Default

    'deeply-equal'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html index bfcd72678b..3f579ae8df 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html @@ -1,4 +1,4 @@ DataProviderSubscribers | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html index 6b81a7a529..4886773625 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html @@ -16,4 +16,4 @@
  • false (or falsy) do not update subscriptions

  • -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html index c76d78c1a7..61e125c32f 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html @@ -1,4 +1,4 @@ DataTypeNames | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.default.html b/papi-dts/types/_shared_models_data_provider_model_.default.html index 06dac9a05d..6f30c7d9bb 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_model_.default.html @@ -2,4 +2,4 @@ object layers over the data provider engine and runs its methods along with other methods. This object is transformed into an IDataProvider by networkObjectService.set.

    Type Parameters

    See

    IDataProvider

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html index 446827f4b4..2cdeccf208 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html @@ -1,2 +1,2 @@ DialogData | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • isDialog: true

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html index acac0886a5..71bb27c071 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional iconUrl?: string

      Url of dialog icon to display in the header. Default is Platform.Bible logo

    • Optional prompt?: string

      The message to show the user in the dialog. Default depends on the dialog

    • Optional title?: string

      Dialog title to display in the header. Default depends on the dialog

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html index 63bc5cf403..e95665f9b5 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index 9fc1383860..7a4058d125 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html @@ -4,4 +4,4 @@ window
  • center - center the window in the dock layout
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html index 2e1add931d..82e63e026d 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • height: number
    • width: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html index f6b3949f60..e56761f8f3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html index d204547292..c624c9d220 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

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html index be426db3e2..b103f89594 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

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html index 4542e8ce90..0dea259f72 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -47,4 +47,4 @@

    Returns

    True if successfully found the WebView to update; false other

  • updateInfo: WebViewDefinitionUpdateInfo

    Properties to update on the WebView. Any unspecified properties will stay the same

  • Returns boolean

    True if successfully found the WebView to update; false otherwise

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html index 74fd1125f9..d4d8310810 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html @@ -7,4 +7,4 @@
  • id: string

    Tab ID - a unique identifier that identifies this tab. If this tab is a WebView, this ID will match the WebViewDefinition.id

  • tabType: string

    Type of tab - indicates what kind of built-in tab this info represents

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html index 4c4e3b49de..db51d01d4c 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html @@ -10,4 +10,4 @@

    Defaults to Platform.Bible logo

  • tabTitle: string

    Text to show on the title bar of the tab

  • Optional tabTooltip?: string

    Text to show when hovering over the title bar of the tab

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html index 96868bc44c..e937f62682 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html index 6b5e36dd62..3ca7a2527f 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html @@ -3,4 +3,4 @@ stripped from TabInfo by saveTabInfoBase before saving (so it is just a SavedTabInfo).

    Type declaration

    Returns

    The saved tab info for Paranext to persist. If undefined, does not save the tab

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html index fc2f67ca11..15b3ae1622 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index 224dbf63c3..b8206cf44b 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

    • TDataProvider

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TDataProvider

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html index 97b9290973..9a0ad942e4 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html index b375a2bb57..77a5d696da 100644 --- a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html +++ b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html @@ -9,4 +9,4 @@ (probably has to do with that it's a wrapped and layered type). Functions that implement this type should return Partial

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html index 1f635d3b14..16a4aab227 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html @@ -5,4 +5,4 @@ call that method. This is because we don't want users of network objects to dispose of them. Only the caller of networkObjectService.set should be able to dispose of the network object.

    Type Parameters

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html index 9b1c3a618e..71b2cd0672 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html @@ -8,4 +8,4 @@ Data Providers => pdp) should be the same across all process on the network regardless of what programming language they use. For generic network objects, networkObject is appropriate.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html index 47e013779c..50ea35aba2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html index 041943b3a2..4a5e4e0760 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html @@ -1,2 +1,2 @@ ProjectDataProviderEngineTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html index 554ede74a5..48b4b3a5d9 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html @@ -9,4 +9,4 @@

    This is the smallest level of granularity provided by a PDP for accessing extension data. There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • extensionName: string

    Name of an extension as provided in its manifest

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html index 273dabbb58..288c17b2b7 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataType.html @@ -11,4 +11,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html index 2c6525abd7..aa72346814 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -5,4 +5,4 @@
  • projectType: ProjectTypes

    Indicates what sort of project this is which implies its data shape (e.g., what data streams should be available)

  • storageType: string

    Indicates how the project is persisted to storage

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html index 3acc6d4d3b..1be660f2f8 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ GetWebViewDefinitionUpdatableProperties | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html index 5118c0d75f..17eeef25ac 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html @@ -11,4 +11,4 @@

    Note: setting existingId to undefined counts as providing in this case (providing is tested with 'existingId' in options, not just testing if existingId is truthy). Not providing an existingId at all is the only way to specify we are not looking for an existing webView

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html index c41fc13b94..37c0934ffa 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html @@ -1,4 +1,4 @@ SavedWebViewDefinition | papi-dts
    SavedWebViewDefinition: (Partial<Omit<WebViewDefinitionReact, "content" | "styles" | "allowScripts">> | Partial<Omit<WebViewDefinitionHtml, "content" | "allowScripts">> | Partial<Omit<WebViewDefinitionURL, "content" | "allowScripts">>) & Pick<WebViewDefinitionBase, "id" | "webViewType">

    Saved WebView information that does not contain the actual content of the WebView. Saved into layouts. Could have as little as the type and ID. WebView providers load these into actual WebViewDefinitions and verify any existing properties on the WebViews.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html index 8a8d590b62..e8dac6f5d8 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -5,4 +5,4 @@

    @example

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

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html index f9357a06a5..db33bc144e 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

      • <T>(stateKey, defaultStateValue): [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]
      • Type Parameters

        • T

        Parameters

        • stateKey: string
        • defaultStateValue: T

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • <T>(stateKey, defaultStateValue): [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]
      • Type Parameters

        • T

        Parameters

        • stateKey: string
        • defaultStateValue: T

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html index 606c1a3704..de444e6245 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html index 8c042ddbee..84d5d242ff 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -65,4 +65,4 @@
  • Optional title?: string

    Name of the tab for the WebView

  • Optional tooltip?: string

    Tooltip that is shown when hovering over the webview title

  • webViewType: WebViewType

    What type of WebView this is. Unique to all other WebView definitions

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html index f1a146093c..2de39f3fbb 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html index 1119c5d729..4113fdcd26 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html index 38ababde12..f73a207061 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html index dc0e186101..dd0e80ecf3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html index 3b7304eeb3..8b8dc27c40 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html index f890204d4b..dd0a4cf30e 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html index 0be3978866..eb7c4b062b 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -35,4 +35,4 @@

    @example

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html index b8ade68124..84d7a1e962 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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index 2c0bf49e82..8119f1f518 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html index 199e64a371..ee062d5066 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,27 +2,27 @@

      Type declaration

      • getMainMenu:function
        • Get menu content for the main menu

          Parameters

          • mainMenuType: undefined

            Does not have to be defined

          Returns Promise<MultiColumnMenu>

          MultiColumnMenu object of main menu content

          -
        • Get menu content for the main menu

          +
        • Get menu content for the main menu

          Returns Promise<MultiColumnMenu>

          MultiColumnMenu object of main menu content

          -
      • getWebViewMenu:function
      • getWebViewMenu:function
        • Get menu content for a web view

          Parameters

          • webViewType: `${string}.${string}`

            The type of webview for which a menu should be retrieved

          Returns Promise<WebViewMenu>

          WebViewMenu object of web view menu content

          -
      • setMainMenu:function
      • setMainMenu:function
      • setWebViewMenu:function
      • setWebViewMenu:function
      • subscribeMainMenu:function
        • Subscribe to run a callback function when the main menu data is changed

          +
      • subscribeMainMenu:function
        • Subscribe to run a callback function when the main menu data is changed

          Parameters

          • mainMenuType: undefined

            Does not have to be defined

          • callback: ((menuContent) => void)

            Function to run with the updated menuContent for this selector

              • (menuContent): void
              • Parameters

                • menuContent: MultiColumnMenu

                Returns void

          • Optional options: DataProviderSubscriberOptions

            Various options to adjust how the subscriber emits updates

          Returns Promise<UnsubscriberAsync>

          Unsubscriber function (run to unsubscribe from listening for updates)

          -
      • subscribeWebViewMenu:function
        • Subscribe to run a callback function when the web view menu data is changed

          +
      • subscribeWebViewMenu:function
        • Subscribe to run a callback function when the web view menu data is changed

          Parameters

          • webViewType: `${string}.${string}`

            The type of webview for which a menu should be subscribed

          • callback: ((menuContent) => void)

            Function to run with the updated menuContent for this selector

              • (menuContent): void
              • Parameters

                • menuContent: WebViewMenu

                Returns void

          • Optional options: DataProviderSubscriberOptions

            Various options to adjust how the subscriber emits updates

          Returns Promise<UnsubscriberAsync>

          Unsubscriber function (run to unsubscribe from listening for updates)

          -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html index 403f1a1787..87c517975b 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

      Generated using TypeDoc

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

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html index b189bcf89e..56cd528075 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

      • TParam extends unknown[] = any[]

      • TReturn = any

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      • TParam extends unknown[] = any[]

      • TReturn = any

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html index af105e4346..57878c6b7f 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

      • TParam = any

      • TReturn = any

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      • TParam = any

      • TReturn = any

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html index 2c772d3987..08f1c27623 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

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      • TParam = any

      • TReturn = any

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_.ResetSettingEvent.html b/papi-dts/types/_shared_services_settings_service_.ResetSettingEvent.html index 959304a550..2fdd40e32f 100644 --- a/papi-dts/types/_shared_services_settings_service_.ResetSettingEvent.html +++ b/papi-dts/types/_shared_services_settings_service_.ResetSettingEvent.html @@ -1,2 +1,2 @@ ResetSettingEvent | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      • type: "reset-setting"

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_.SettingEvent.html b/papi-dts/types/_shared_services_settings_service_.SettingEvent.html index b2e0e7684b..7d8cdb415d 100644 --- a/papi-dts/types/_shared_services_settings_service_.SettingEvent.html +++ b/papi-dts/types/_shared_services_settings_service_.SettingEvent.html @@ -1,2 +1,2 @@ SettingEvent | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_.UpdateSettingEvent.html b/papi-dts/types/_shared_services_settings_service_.UpdateSettingEvent.html index 740b607212..b366f5c638 100644 --- a/papi-dts/types/_shared_services_settings_service_.UpdateSettingEvent.html +++ b/papi-dts/types/_shared_services_settings_service_.UpdateSettingEvent.html @@ -1,2 +1,2 @@ UpdateSettingEvent | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexRequest.html b/papi-dts/types/_shared_utils_util_.ComplexRequest.html index 8bbba660eb..a811195758 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

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponse.html b/papi-dts/types/_shared_utils_util_.ComplexResponse.html index 9b60e661af..6ebe9261d3 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

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      • TReturn = unknown

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html index 153c18c115..02989418e3 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

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html index 84639e0f76..34e8e56d27 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

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index 84c2d76fa7..bd70751510 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

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index 9f23f92f1e..d6eb4e7c74 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

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index 4828c44a5c..ed0d71a074 100644 --- a/papi-dts/variables/__papi_backend_.DataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.DataProviderEngine.html @@ -2,4 +2,4 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

      See

      IDataProviderEngine for more information on extending this class.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index a077f4d10e..72936d0f57 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index c015698b60..ddae1b65e2 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index 51b3980d60..98bf531b41 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -21,4 +21,4 @@
    • webViews: WebViewServiceType

      Service exposing various functions related to using webViews

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

      -
    • Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index c065832e8c..5eb78312ac 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index d756399e19..d915186ea5 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index 030c817bc1..a9e00e6362 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      • default: MainLogger

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index 7aa3876657..f401bf2008 100644 --- a/papi-dts/variables/__papi_backend_.menuData.html +++ b/papi-dts/variables/__papi_backend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index c0fc730190..234f713813 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index 0a6aad7792..972bb747e0 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index 40e6ac096b..d42598eff8 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index ab0e653806..1c6e75e429 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index dc237e6c0f..8621723455 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,2 +1,2 @@ webViewProviders | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 5d0149734c..4962910126 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 18a941431f..767f251340 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index 25ec6c0ef7..3f83bf2dab 100644 --- a/papi-dts/variables/__papi_frontend_.WebSocket.html +++ b/papi-dts/variables/__papi_frontend_.WebSocket.html @@ -2,4 +2,4 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index f18a97b5e8..c9272d3cef 100644 --- a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html +++ b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html @@ -2,4 +2,4 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index 2488b0dc38..25cbb77b6f 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index 0381fe3c35..e27b0f8fd4 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index ffe982d074..5c9b959559 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -23,4 +23,4 @@
      • webViews: WebViewServiceType

        Service exposing various functions related to using webViews

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

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index e71ef724ce..583dc5e826 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index 310bc713c6..3eebf3bc01 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index 75556bc1d5..62b833f3e4 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • default: MainLogger

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index 43f4a4f109..3cab1e4b79 100644 --- a/papi-dts/variables/__papi_frontend_.menuData.html +++ b/papi-dts/variables/__papi_frontend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index 9254c6f349..1c45bf6687 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 21c1dbc4bf..1855db9f42 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index e334636ee6..24ad33c036 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 5bc2858d5c..6301fc14f6 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index a01fe6c365..a6fa3dfec1 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1,2 +1,2 @@ settings | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index 5b38ce6883..50dd7fc51e 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html index fa8e4b8adb..3a0d286219 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_services_execution_token_service_.default.html b/papi-dts/variables/_node_services_execution_token_service_.default.html index a954e34cdc..582a371b55 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

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index aeac101dfc..12cd219839 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

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index ab8f518cab..4b0620e765 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

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html index c0cd57262a..073e9fd1b1 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html @@ -5,4 +5,4 @@ we would not be able to use the default loadDialog because it would be using a static reference to a nonexistent Component. Instead of inheriting this as a class, any dialog definition can spread this { ...DIALOG_BASE }

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html index 300803821a..a3c5d2cd56 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html index 272e504e02..cd8762bbbc 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html index 5830ed2022..56f6e5e64f 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html index e814d83b8c..24d1617417 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html index d42e7054b9..57676b26cc 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html index 7e79eeb50b..e4375a41ac 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

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • clientId: -1

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html index a61ef2d35c..7b279c3ea9 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html index 6d2662e2c1..de5945c019 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html index 905afeecc4..e4ebc194f9 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_data_provider_service_.default.html b/papi-dts/variables/_shared_services_data_provider_service_.default.html index 620fdad466..861e63c84b 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 0c51e96063..6c01d6a4d3 100644 --- a/papi-dts/variables/_shared_services_dialog_service_.default.html +++ b/papi-dts/variables/_shared_services_dialog_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html index 619352cd58..cfe6594493 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index 55d50b5823..cefbc9f0ee 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html index a1c9cebe80..1e32167c91 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

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index 477d3c988d..5819d00083 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

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • default: log.MainLogger

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_.default.html b/papi-dts/variables/_shared_services_menu_data_service_.default.html index 696e854e22..d219e23478 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_.default.html +++ b/papi-dts/variables/_shared_services_menu_data_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html index 00053988c4..f7eea08573 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html index e533c7fefb..37179e7bdd 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_service_.default.html b/papi-dts/variables/_shared_services_network_object_service_.default.html index db2c3d57e6..7b9b18fc86 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_service_.default.html @@ -18,4 +18,4 @@

        When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_.default.html b/papi-dts/variables/_shared_services_network_object_status_service_.default.html index 2628db8de8..a4615cd5d0 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index df5ae3dd28..68be51bd8f 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index e6b202f01c..cc8fa6651e 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html index 4ac914dd02..17644fd9c2 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html index a51956090e..03fd57c4e7 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

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • get: typeof get

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_.default.html b/papi-dts/variables/_shared_services_project_lookup_service_.default.html index 768d09a95e..1fc2734925 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_.default.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html index 3cc53c70ed..374abd26d2 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html @@ -1 +1 @@ -projectLookupServiceNetworkObjectName | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index 418e30588e..e1767b5215 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html index 52b3953bb8..595040a900 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html index f9ae7e6565..70a6201eeb 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_.default.html b/papi-dts/variables/_shared_services_web_view_service_.default.html index 9d981d7a6d..155bb1cd2e 100644 --- a/papi-dts/variables/_shared_services_web_view_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html index f2a37f9770..5de64a6d69 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html index 85d7bdecf5..a126036412 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

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html index 6305d3168a..8a3e53e8bd 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

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        • [moduleName: string]: string | {
              [process in ProcessType | "default"]?: string
          } | undefined

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html index e989baaccb..d8a49c9e3e 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

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index bb3fd9df5a..ab43ec13bd 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 4043cab970..6ec4b57447 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index ad93db3286..540703ac00 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index a9ae8c227f..2bcbba61f2 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/enums/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index a0697c125f..d2dc996e24 100644 --- a/platform-bible-react/enums/LabelPosition.html +++ b/platform-bible-react/enums/LabelPosition.html @@ -1,5 +1,5 @@ -LabelPosition | platform-bible-react

        Enumeration LabelPosition

        Enumeration Members

        Above +LabelPosition | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Enumeration Members

        Above: "above"
        After: "after"
        Before: "before"
        Below: "below"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index db94e0b97d..49b66b14c1 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ Button | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index 4a652df6f2..6ed21d0dc5 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +ChapterRangeSelector | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index 0e9893dcba..4880b7b50b 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,2 +1,2 @@ Checkbox | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 407abe6f40..f9648ff2d1 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index 1583440b5b..c42756d2c8 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +GridMenu | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index b4a1a0babe..ad34bd5907 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 792f44c67b..e5daa798e0 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +MenuItem | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/RefSelector.html b/platform-bible-react/functions/RefSelector.html index 55682fecff..6a0767c992 100644 --- a/platform-bible-react/functions/RefSelector.html +++ b/platform-bible-react/functions/RefSelector.html @@ -1 +1 @@ -RefSelector | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +RefSelector | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index e8995d3f67..3faca7fd59 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +SearchBar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index 8649a2a637..91332f6fa8 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ Slider | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Snackbar.html b/platform-bible-react/functions/Snackbar.html index f83cbee492..29d613c129 100644 --- a/platform-bible-react/functions/Snackbar.html +++ b/platform-bible-react/functions/Snackbar.html @@ -1,4 +1,4 @@ Snackbar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index 2855c3a98f..868c807fbc 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ Switch | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index 067ce52854..bc737ab68f 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ Table | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        • R

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index ad185e0f74..f2c7316dce 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index 8e3d21fe48..b620adecaf 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +Toolbar | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index 8e90f44314..35df69e876 100644 --- a/platform-bible-react/functions/useEvent.html +++ b/platform-bible-react/functions/useEvent.html @@ -9,4 +9,4 @@
      • eventHandler: PlatformEventHandler<T>

        The callback to run when the event is emitted

        WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

        -
      • Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index e6006bc251..ff23f3f083 100644 --- a/platform-bible-react/functions/useEventAsync.html +++ b/platform-bible-react/functions/useEventAsync.html @@ -10,4 +10,4 @@
      • eventHandler: PlatformEventHandler<T>

        The callback to run when the event is emitted

        WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

        -
      • Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index 07404e7ec0..438308b311 100644 --- a/platform-bible-react/functions/usePromise.html +++ b/platform-bible-react/functions/usePromise.html @@ -21,4 +21,4 @@
      • value: the current value for the promise, either the defaultValue or the resolved promise value
      • isLoading: whether the promise is waiting to be resolved
      • -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index 0caf509fa2..a4a7a229c6 100644 --- a/platform-bible-react/interfaces/CommandHandler.html +++ b/platform-bible-react/interfaces/CommandHandler.html @@ -1 +1 @@ -CommandHandler | platform-bible-react

        Interface CommandHandler

        interface CommandHandler ((command) => void)

        Generated using TypeDoc

        \ No newline at end of file +CommandHandler | platform-bible-react

        Interface CommandHandler

        interface CommandHandler ((command) => void)

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/ScrRefSelectorProps.html b/platform-bible-react/interfaces/ScrRefSelectorProps.html index 32e574735d..e46a828be9 100644 --- a/platform-bible-react/interfaces/ScrRefSelectorProps.html +++ b/platform-bible-react/interfaces/ScrRefSelectorProps.html @@ -1,4 +1,4 @@ -ScrRefSelectorProps | platform-bible-react

        Interface ScrRefSelectorProps

        interface ScrRefSelectorProps {
            handleSubmit: ((scrRef) => void);
            id?: string;
            scrRef: ScriptureReference;
        }

        Properties

        handleSubmit +ScrRefSelectorProps | platform-bible-react

        Interface ScrRefSelectorProps

        interface ScrRefSelectorProps {
            handleSubmit: ((scrRef) => void);
            id?: string;
            scrRef: ScriptureReference;
        }

        Properties

        Properties

        handleSubmit: ((scrRef) => void)

        Type declaration

          • (scrRef): void
          • Parameters

            • scrRef: ScriptureReference

            Returns void

        id?: string
        scrRef: ScriptureReference

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        handleSubmit: ((scrRef) => void)

        Type declaration

          • (scrRef): void
          • Parameters

            • scrRef: ScriptureReference

            Returns void

        id?: string
        scrRef: ScriptureReference

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/TableCalculatedColumn.html b/platform-bible-react/interfaces/TableCalculatedColumn.html index 5fa00794d9..3b9534104f 100644 --- a/platform-bible-react/interfaces/TableCalculatedColumn.html +++ b/platform-bible-react/interfaces/TableCalculatedColumn.html @@ -1,4 +1,4 @@ -TableCalculatedColumn | platform-bible-react

        Interface TableCalculatedColumn<R>

        interface TableCalculatedColumn<R> {
            editable?: null | boolean | ((row) => boolean);
            frozen: boolean;
            idx: number;
            isLastFrozenColumn: boolean;
            key: string;
            maxWidth: undefined | number;
            minWidth: number;
            name: string | ReactElement<any, string | JSXElementConstructor<any>>;
            renderCell: ((props) => ReactNode);
            renderEditCell?: null | ((props) => ReactNode);
            resizable: boolean;
            rowGroup: boolean;
            sortDescendingFirst?: null | boolean;
            sortable: boolean;
            width: string | number;
        }

        Type Parameters

        • R

        Hierarchy (view full)

        Properties

        editable? +TableCalculatedColumn | platform-bible-react

        Interface TableCalculatedColumn<R>

        interface TableCalculatedColumn<R> {
            editable?: null | boolean | ((row) => boolean);
            frozen: boolean;
            idx: number;
            isLastFrozenColumn: boolean;
            key: string;
            maxWidth: undefined | number;
            minWidth: number;
            name: string | ReactElement<any, string | JSXElementConstructor<any>>;
            renderCell: ((props) => ReactNode);
            renderEditCell?: null | ((props) => ReactNode);
            resizable: boolean;
            rowGroup: boolean;
            sortDescendingFirst?: null | boolean;
            sortable: boolean;
            width: string | number;
        }

        Type Parameters

        • R

        Hierarchy (view full)

        Properties

        editable? frozen idx isLastFrozenColumn @@ -17,10 +17,10 @@ the default text editor will be used for editing. Note: If editable is set to 'true' and no custom renderEditCell is provided, the internal logic that sets the renderEditCell will shallow clone the column.

        -

        Type declaration

          • (row): boolean
          • Parameters

            • row: R

            Returns boolean

        frozen: boolean
        idx: number
        isLastFrozenColumn: boolean
        key: string

        A unique key to distinguish each column

        -
        maxWidth: undefined | number
        minWidth: number
        name: string | ReactElement<any, string | JSXElementConstructor<any>>

        The name of the column. By default it will be displayed in the header cell

        -
        renderCell: ((props) => ReactNode)

        Type declaration

          • (props): ReactNode
          • Parameters

            • props: RenderCellProps<R, unknown>

            Returns ReactNode

        renderEditCell?: null | ((props) => ReactNode)

        Editor to be rendered when cell of column is being edited. Don't forget to also set the +

        Type declaration

          • (row): boolean
          • Parameters

            • row: R

            Returns boolean

        frozen: boolean
        idx: number
        isLastFrozenColumn: boolean
        key: string

        A unique key to distinguish each column

        +
        maxWidth: undefined | number
        minWidth: number
        name: string | ReactElement<any, string | JSXElementConstructor<any>>

        The name of the column. By default it will be displayed in the header cell

        +
        renderCell: ((props) => ReactNode)

        Type declaration

          • (props): ReactNode
          • Parameters

            • props: RenderCellProps<R, unknown>

            Returns ReactNode

        renderEditCell?: null | ((props) => ReactNode)

        Editor to be rendered when cell of column is being edited. Don't forget to also set the editable prop to true in order to enable editing.

        -

        Type declaration

        resizable: boolean
        rowGroup: boolean
        sortDescendingFirst?: null | boolean

        Sets the column sort order to be descending instead of ascending the first time the column is +

        Type declaration

        resizable: boolean
        rowGroup: boolean
        sortDescendingFirst?: null | boolean

        Sets the column sort order to be descending instead of ascending the first time the column is sorted

        -
        sortable: boolean
        width: string | number

        Generated using TypeDoc

        \ No newline at end of file +
        sortable: boolean
        width: string | number

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/interfaces/ToolbarDataHandler.html b/platform-bible-react/interfaces/ToolbarDataHandler.html index d1f7bd0491..50308a7c4b 100644 --- a/platform-bible-react/interfaces/ToolbarDataHandler.html +++ b/platform-bible-react/interfaces/ToolbarDataHandler.html @@ -1 +1 @@ -ToolbarDataHandler | platform-bible-react

        Interface ToolbarDataHandler

        interface ToolbarDataHandler ((isSupportAndDevelopment) => GridMenuInfo)

        Generated using TypeDoc

        \ No newline at end of file +ToolbarDataHandler | platform-bible-react

        Interface ToolbarDataHandler

        interface ToolbarDataHandler ((isSupportAndDevelopment) => GridMenuInfo)

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/AnchorOrigin.html b/platform-bible-react/types/AnchorOrigin.html index 4050acc670..d0ff418632 100644 --- a/platform-bible-react/types/AnchorOrigin.html +++ b/platform-bible-react/types/AnchorOrigin.html @@ -1 +1 @@ -AnchorOrigin | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +AnchorOrigin | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ButtonProps.html b/platform-bible-react/types/ButtonProps.html index 8aa8a7820a..16b522ddcd 100644 --- a/platform-bible-react/types/ButtonProps.html +++ b/platform-bible-react/types/ButtonProps.html @@ -5,4 +5,4 @@
      • Optional onClick?: MouseEventHandler<HTMLButtonElement>

        Optional click handler

      • Optional onContextMenu?: MouseEventHandler<HTMLButtonElement>

        Optional context menu handler

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 20bfeb6292..12a7748c28 100644 --- a/platform-bible-react/types/ChapterRangeSelectorProps.html +++ b/platform-bible-react/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | platform-bible-react

        Type alias ChapterRangeSelectorProps

        ChapterRangeSelectorProps: {
            chapterCount: number;
            endChapter: number;
            handleSelectEndChapter: ((chapter) => void);
            handleSelectStartChapter: ((chapter) => void);
            isDisabled?: boolean;
            startChapter: number;
        }

        Type declaration

        • chapterCount: number
        • endChapter: number
        • handleSelectEndChapter: ((chapter) => void)
            • (chapter): void
            • Parameters

              • chapter: number

              Returns void

        • handleSelectStartChapter: ((chapter) => void)
            • (chapter): void
            • Parameters

              • chapter: number

              Returns void

        • Optional isDisabled?: boolean
        • startChapter: number

        Generated using TypeDoc

        \ No newline at end of file +ChapterRangeSelectorProps | platform-bible-react

        Type alias ChapterRangeSelectorProps

        ChapterRangeSelectorProps: {
            chapterCount: number;
            endChapter: number;
            handleSelectEndChapter: ((chapter) => void);
            handleSelectStartChapter: ((chapter) => void);
            isDisabled?: boolean;
            startChapter: number;
        }

        Type declaration

        • chapterCount: number
        • endChapter: number
        • handleSelectEndChapter: ((chapter) => void)
            • (chapter): void
            • Parameters

              • chapter: number

              Returns void

        • handleSelectStartChapter: ((chapter) => void)
            • (chapter): void
            • Parameters

              • chapter: number

              Returns void

        • Optional isDisabled?: boolean
        • startChapter: number

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/CheckboxProps.html b/platform-bible-react/types/CheckboxProps.html index bfad44cace..0d4175594c 100644 --- a/platform-bible-react/types/CheckboxProps.html +++ b/platform-bible-react/types/CheckboxProps.html @@ -25,4 +25,4 @@

        Parameters

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/CloseReason.html b/platform-bible-react/types/CloseReason.html index b13d8b59b3..4586190525 100644 --- a/platform-bible-react/types/CloseReason.html +++ b/platform-bible-react/types/CloseReason.html @@ -1 +1 @@ -CloseReason | platform-bible-react

        Type alias CloseReason

        CloseReason: SnackbarCloseReason

        Generated using TypeDoc

        \ No newline at end of file +CloseReason | platform-bible-react

        Type alias CloseReason

        CloseReason: SnackbarCloseReason

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeDetails.html b/platform-bible-react/types/ComboBoxChangeDetails.html index fa2239b872..2371f5ed50 100644 --- a/platform-bible-react/types/ComboBoxChangeDetails.html +++ b/platform-bible-react/types/ComboBoxChangeDetails.html @@ -1 +1 @@ -ComboBoxChangeDetails | platform-bible-react

        Type alias ComboBoxChangeDetails<T>

        ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

        Type Parameters

        • T

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxChangeDetails | platform-bible-react

        Type alias ComboBoxChangeDetails<T>

        ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

        Type Parameters

        • T

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeReason.html b/platform-bible-react/types/ComboBoxChangeReason.html index d455ab8b2e..d4322c5756 100644 --- a/platform-bible-react/types/ComboBoxChangeReason.html +++ b/platform-bible-react/types/ComboBoxChangeReason.html @@ -1 +1 @@ -ComboBoxChangeReason | platform-bible-react

        Type alias ComboBoxChangeReason

        ComboBoxChangeReason: AutocompleteChangeReason

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxChangeReason | platform-bible-react

        Type alias ComboBoxChangeReason

        ComboBoxChangeReason: AutocompleteChangeReason

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index d0c3cbc8f0..328d632dcf 100644 --- a/platform-bible-react/types/ComboBoxLabelOption.html +++ b/platform-bible-react/types/ComboBoxLabelOption.html @@ -1 +1 @@ -ComboBoxLabelOption | platform-bible-react

        Type alias ComboBoxLabelOption

        ComboBoxLabelOption: {
            label: string;
        }

        Type declaration

        • label: string

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxLabelOption | platform-bible-react

        Type alias ComboBoxLabelOption

        ComboBoxLabelOption: {
            label: string;
        }

        Type declaration

        • label: string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index b5edefcd99..ff0a19ee20 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

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxOption | platform-bible-react

        Type alias ComboBoxOption

        ComboBoxOption: string | number | ComboBoxLabelOption

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index a43494900c..1a6de2901b 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -23,4 +23,4 @@
      • Optional value?: T

        The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

      • Optional width?: number

        Width of the combobox in pixels. Setting this prop overrides the isFullWidth prop

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxValue.html b/platform-bible-react/types/ComboBoxValue.html index 4fc4a4d519..1bda1c3e2a 100644 --- a/platform-bible-react/types/ComboBoxValue.html +++ b/platform-bible-react/types/ComboBoxValue.html @@ -1 +1 @@ -ComboBoxValue | platform-bible-react

        Type alias ComboBoxValue<T, X, Y, Z>

        ComboBoxValue<T, X, Y, Z>: AutocompleteValue<T, X, Y, Z>

        Type Parameters

        • T

        • X

        • Y

        • Z

        Generated using TypeDoc

        \ No newline at end of file +ComboBoxValue | platform-bible-react

        Type alias ComboBoxValue<T, X, Y, Z>

        ComboBoxValue<T, X, Y, Z>: AutocompleteValue<T, X, Y, Z>

        Type Parameters

        • T

        • X

        • Y

        • Z

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/Command.html b/platform-bible-react/types/Command.html index 4bca2d6858..c494423845 100644 --- a/platform-bible-react/types/Command.html +++ b/platform-bible-react/types/Command.html @@ -1,3 +1,3 @@ Command | platform-bible-react

        Type alias Command

        Command: {
            command: string;
            name: string;
        }

        Type declaration

        • command: string

          Command to execute (string.string)

        • name: string

          Text (displayable in the UI) as the name of the command

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index a3f6b1580e..ceeaffd205 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: {
            columns: MenuColumn[];
        }

        Type declaration

        • columns: MenuColumn[]

          The columns to display on the dropdown menu.

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index 311e8d5cec..57e4cdd312 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 toolbar

        • commandHandler: CommandHandler
        • Optional id?: string

          Optional unique identifier

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index a1f0d87565..dd550847f8 100644 --- a/platform-bible-react/types/IconButtonProps.html +++ b/platform-bible-react/types/IconButtonProps.html @@ -16,4 +16,4 @@

        Default

        false
         
      • Optional tooltip?: string

        Optional tooltip to display if different from the aria-label.

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/MenuColumn.html b/platform-bible-react/types/MenuColumn.html index f4c9ab254c..3e90092158 100644 --- a/platform-bible-react/types/MenuColumn.html +++ b/platform-bible-react/types/MenuColumn.html @@ -1,2 +1,2 @@ MenuColumn | platform-bible-react

        Type alias MenuColumn

        MenuColumn: {
            items: MenuItemInfo[];
            name: string;
        }

        Type declaration

        • items: MenuItemInfo[]
        • name: string

          The name of the menu (displayed as the column header).

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemInfo.html b/platform-bible-react/types/MenuItemInfo.html index 6a0e45807e..b88802a71d 100644 --- a/platform-bible-react/types/MenuItemInfo.html +++ b/platform-bible-react/types/MenuItemInfo.html @@ -12,4 +12,4 @@
      • Optional isDense?: boolean

        If true, compact vertical padding designed for keyboard and mouse input is used.

        Default

        true
         
        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemProps.html b/platform-bible-react/types/MenuItemProps.html index c1d1975ab7..10457cef8c 100644 --- a/platform-bible-react/types/MenuItemProps.html +++ b/platform-bible-react/types/MenuItemProps.html @@ -1 +1 @@ -MenuItemProps | platform-bible-react

        Type alias MenuItemProps

        MenuItemProps: Omit<MenuItemInfo, "command"> & PropsWithChildren<{
            id?: string;
            onClick: (() => void);
        }>

        Generated using TypeDoc

        \ No newline at end of file +MenuItemProps | platform-bible-react

        Type alias MenuItemProps

        MenuItemProps: Omit<MenuItemInfo, "command"> & PropsWithChildren<{
            id?: string;
            onClick: (() => void);
        }>

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index 18f080550e..f42e0cd87f 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -2,4 +2,4 @@
      • onSearch: ((searchQuery) => void)

        Callback fired to handle the search query when button pressed

        Param: searchQuery

      • Optional placeholder?: string

        Optional string that appears in the search bar without a search string

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SliderProps.html b/platform-bible-react/types/SliderProps.html index 159899dd90..e712e6bf24 100644 --- a/platform-bible-react/types/SliderProps.html +++ b/platform-bible-react/types/SliderProps.html @@ -49,4 +49,4 @@

        Param: value

        The new value.

        Default

        'off'
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarContentProps.html b/platform-bible-react/types/SnackbarContentProps.html index 0846ac1485..da62548305 100644 --- a/platform-bible-react/types/SnackbarContentProps.html +++ b/platform-bible-react/types/SnackbarContentProps.html @@ -1,4 +1,4 @@ SnackbarContentProps | platform-bible-react

        Type alias SnackbarContentProps

        SnackbarContentProps: {
            action?: ReactNode;
            className?: string;
            message?: ReactNode;
        }

        Type declaration

        • Optional action?: ReactNode

          The action to display, renders after the message

        • Optional className?: string

          Additional css classes to help with unique styling of the snackbar, internal

        • Optional message?: ReactNode

          The message to display

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarProps.html b/platform-bible-react/types/SnackbarProps.html index 392354976c..ec47296d26 100644 --- a/platform-bible-react/types/SnackbarProps.html +++ b/platform-bible-react/types/SnackbarProps.html @@ -14,4 +14,4 @@ string

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/SwitchProps.html b/platform-bible-react/types/SwitchProps.html index ffce1bb864..7fa763e71f 100644 --- a/platform-bible-react/types/SwitchProps.html +++ b/platform-bible-react/types/SwitchProps.html @@ -15,4 +15,4 @@

        Parameters

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellClickArgs.html b/platform-bible-react/types/TableCellClickArgs.html index c2e1aa6042..1c5be1f750 100644 --- a/platform-bible-react/types/TableCellClickArgs.html +++ b/platform-bible-react/types/TableCellClickArgs.html @@ -1 +1 @@ -TableCellClickArgs | platform-bible-react

        Type alias TableCellClickArgs<R>

        TableCellClickArgs<R>: CellClickArgs<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TableCellClickArgs | platform-bible-react

        Type alias TableCellClickArgs<R>

        TableCellClickArgs<R>: CellClickArgs<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyDownArgs.html b/platform-bible-react/types/TableCellKeyDownArgs.html index 1e1e114e20..c4ca549106 100644 --- a/platform-bible-react/types/TableCellKeyDownArgs.html +++ b/platform-bible-react/types/TableCellKeyDownArgs.html @@ -1 +1 @@ -TableCellKeyDownArgs | platform-bible-react

        Type alias TableCellKeyDownArgs<R>

        TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TableCellKeyDownArgs | platform-bible-react

        Type alias TableCellKeyDownArgs<R>

        TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyboardEvent.html b/platform-bible-react/types/TableCellKeyboardEvent.html index 4c5ed63711..a876e216ce 100644 --- a/platform-bible-react/types/TableCellKeyboardEvent.html +++ b/platform-bible-react/types/TableCellKeyboardEvent.html @@ -1 +1 @@ -TableCellKeyboardEvent | platform-bible-react

        Type alias TableCellKeyboardEvent

        TableCellKeyboardEvent: CellKeyboardEvent

        Generated using TypeDoc

        \ No newline at end of file +TableCellKeyboardEvent | platform-bible-react

        Type alias TableCellKeyboardEvent

        TableCellKeyboardEvent: CellKeyboardEvent

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCellMouseEvent.html b/platform-bible-react/types/TableCellMouseEvent.html index 4630cb0079..05dad5342e 100644 --- a/platform-bible-react/types/TableCellMouseEvent.html +++ b/platform-bible-react/types/TableCellMouseEvent.html @@ -1 +1 @@ -TableCellMouseEvent | platform-bible-react

        Type alias TableCellMouseEvent

        TableCellMouseEvent: CellMouseEvent

        Generated using TypeDoc

        \ No newline at end of file +TableCellMouseEvent | platform-bible-react

        Type alias TableCellMouseEvent

        TableCellMouseEvent: CellMouseEvent

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableColumn.html b/platform-bible-react/types/TableColumn.html index 09a1891e6d..bd26631f93 100644 --- a/platform-bible-react/types/TableColumn.html +++ b/platform-bible-react/types/TableColumn.html @@ -15,4 +15,4 @@
      • Optional Readonly sortable?: boolean

        Enable sorting of a column

      • Optional Readonly width?: number | string

        Column width. If not specified, it will be determined automatically based on grid width and specified widths of other columns

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableCopyEvent.html b/platform-bible-react/types/TableCopyEvent.html index 500914cb3c..4301a2c955 100644 --- a/platform-bible-react/types/TableCopyEvent.html +++ b/platform-bible-react/types/TableCopyEvent.html @@ -1 +1 @@ -TableCopyEvent | platform-bible-react

        Type alias TableCopyEvent<R>

        TableCopyEvent<R>: CopyEvent<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TableCopyEvent | platform-bible-react

        Type alias TableCopyEvent<R>

        TableCopyEvent<R>: CopyEvent<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableEditorProps.html b/platform-bible-react/types/TableEditorProps.html index 0c85f88ae1..81baee8ea0 100644 --- a/platform-bible-react/types/TableEditorProps.html +++ b/platform-bible-react/types/TableEditorProps.html @@ -1 +1 @@ -TableEditorProps | platform-bible-react

        Type alias TableEditorProps<R>

        TableEditorProps<R>: {
            column: TableCalculatedColumn<R>;
            onClose: ((commitChanges?) => void);
            onRowChange: ((row, commitChanges?) => void);
            row: R;
        }

        Type Parameters

        • R

        Type declaration

        • column: TableCalculatedColumn<R>
        • onClose: ((commitChanges?) => void)
            • (commitChanges?): void
            • Parameters

              • Optional commitChanges: boolean

              Returns void

        • onRowChange: ((row, commitChanges?) => void)
            • (row, commitChanges?): void
            • Parameters

              • row: R
              • Optional commitChanges: boolean

              Returns void

        • row: R

        Generated using TypeDoc

        \ No newline at end of file +TableEditorProps | platform-bible-react

        Type alias TableEditorProps<R>

        TableEditorProps<R>: {
            column: TableCalculatedColumn<R>;
            onClose: ((commitChanges?) => void);
            onRowChange: ((row, commitChanges?) => void);
            row: R;
        }

        Type Parameters

        • R

        Type declaration

        • column: TableCalculatedColumn<R>
        • onClose: ((commitChanges?) => void)
            • (commitChanges?): void
            • Parameters

              • Optional commitChanges: boolean

              Returns void

        • onRowChange: ((row, commitChanges?) => void)
            • (row, commitChanges?): void
            • Parameters

              • row: R
              • Optional commitChanges: boolean

              Returns void

        • row: R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TablePasteEvent.html b/platform-bible-react/types/TablePasteEvent.html index f77bb5f7fb..b722112f15 100644 --- a/platform-bible-react/types/TablePasteEvent.html +++ b/platform-bible-react/types/TablePasteEvent.html @@ -1 +1 @@ -TablePasteEvent | platform-bible-react

        Type alias TablePasteEvent<R>

        TablePasteEvent<R>: PasteEvent<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TablePasteEvent | platform-bible-react

        Type alias TablePasteEvent<R>

        TablePasteEvent<R>: PasteEvent<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableProps.html b/platform-bible-react/types/TableProps.html index 03f2866170..b640ccc1c6 100644 --- a/platform-bible-react/types/TableProps.html +++ b/platform-bible-react/types/TableProps.html @@ -74,4 +74,4 @@

        Param: width

        The new width of the column in pixels

      • Optional selectedRows?: ReadonlySet<Key>

        A set of keys representing the currently selected rows

      • Optional sortColumns?: readonly TableSortColumn[]

        An array of objects representing the currently sorted columns

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableRowsChangeData.html b/platform-bible-react/types/TableRowsChangeData.html index ae632281b5..64c471fb52 100644 --- a/platform-bible-react/types/TableRowsChangeData.html +++ b/platform-bible-react/types/TableRowsChangeData.html @@ -1 +1 @@ -TableRowsChangeData | platform-bible-react

        Type alias TableRowsChangeData<R>

        TableRowsChangeData<R>: RowsChangeData<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file +TableRowsChangeData | platform-bible-react

        Type alias TableRowsChangeData<R>

        TableRowsChangeData<R>: RowsChangeData<R>

        Type Parameters

        • R

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TableSortColumn.html b/platform-bible-react/types/TableSortColumn.html index de05acba84..ee56cd89a4 100644 --- a/platform-bible-react/types/TableSortColumn.html +++ b/platform-bible-react/types/TableSortColumn.html @@ -1 +1 @@ -TableSortColumn | platform-bible-react

        Type alias TableSortColumn

        TableSortColumn: SortColumn

        Generated using TypeDoc

        \ No newline at end of file +TableSortColumn | platform-bible-react

        Type alias TableSortColumn

        TableSortColumn: SortColumn

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index a203fd9b22..4773b0a561 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -23,4 +23,4 @@
      • Optional variant?: "outlined" | "filled"

        The variant to use.

        Default

        'outlined'
         
        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index 36199af035..c39593ccb0 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
      • Optional dataHandler?: ToolbarDataHandler

        The handler to use for menu data if there is no menu provided.

      • Optional id?: string

        Optional unique identifier

      • Optional menu?: GridMenuInfo

        The optional grid menu to display. If not specified, the "hamburger" menu will not display.

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index 14625d777f..d57f815641 100644 --- a/platform-bible-react/types/UsePromiseOptions.html +++ b/platform-bible-react/types/UsePromiseOptions.html @@ -1,3 +1,3 @@ UsePromiseOptions | platform-bible-react

        Type alias UsePromiseOptions

        UsePromiseOptions: {
            preserveValue?: boolean;
        }

        Type declaration

        • Optional preserveValue?: boolean

          Whether to leave the value as the most recent resolved promise value or set it back to defaultValue while running the promise again. Defaults to true

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index fd0f89a0cf..9bea5b67ce 100644 --- a/platform-bible-utils/classes/AsyncVariable.html +++ b/platform-bible-utils/classes/AsyncVariable.html @@ -1,5 +1,5 @@ AsyncVariable | platform-bible-utils

        Class AsyncVariable<T>

        This class provides a convenient way for one task to wait on a variable that another task sets.

        -

        Type Parameters

        • T

        Constructors

        Type Parameters

        • T

        Constructors

        Properties

        promiseToValue rejecter resolver @@ -14,18 +14,18 @@
      • rejectIfNotSettledWithinMS: number = 10000

        Milliseconds to wait before verifying if the promise was settled (resolved or rejected); will reject if it has not settled by that time. Use -1 if you do not want a timeout at all.

        -
      • Returns AsyncVariable<T>

        Properties

        promiseToValue: Promise<T>
        rejecter: undefined | ((reason) => void)

        Type declaration

          • (reason): void
          • Parameters

            • reason: undefined | string

            Returns void

        resolver: undefined | ((value) => void)

        Type declaration

          • (value): void
          • Parameters

            • value: T

            Returns void

        variableName: string

        Accessors

        • get hasSettled(): boolean
        • A simple way to see if this variable's promise was resolved or rejected already

          +

        Returns AsyncVariable<T>

        Properties

        promiseToValue: Promise<T>
        rejecter: undefined | ((reason) => void)

        Type declaration

          • (reason): void
          • Parameters

            • reason: undefined | string

            Returns void

        resolver: undefined | ((value) => void)

        Type declaration

          • (value): void
          • Parameters

            • value: T

            Returns void

        variableName: string

        Accessors

        • get hasSettled(): boolean
        • A simple way to see if this variable's promise was resolved or rejected already

          Returns boolean

          Whether the variable was already resolved or rejected

          -
        • get promise(): Promise<T>
        • Get this variable's promise to a value. This always returns the same promise even after the +

        • 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

        • Prevent any further updates to this variable

          -

          Returns void

        • Reject this variable's promise for the value with the given reason

          +

        Methods

        • Prevent any further updates to this variable

          +

          Returns 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

            -

          Returns void

        • Resolve this variable's promise to the given value

          +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/DocumentCombinerEngine.html b/platform-bible-utils/classes/DocumentCombinerEngine.html index 14ec8397e2..6be53cdaa7 100644 --- a/platform-bible-utils/classes/DocumentCombinerEngine.html +++ b/platform-bible-utils/classes/DocumentCombinerEngine.html @@ -1,6 +1,6 @@ DocumentCombinerEngine | platform-bible-utils

        Class DocumentCombinerEngineAbstract

        Base class for any code that wants to compose JSON documents (in the form of JS objects) together into a single output document.

        -

        Constructors

        Constructors

        Properties

        Constructors

        Properties

        baseDocument: JsonDocumentLike
        contributions: Map<string, JsonDocumentLike> = ...
        latestOutput: undefined | JsonDocumentLike

        Methods

        • Add or update one of the contribution documents for the composition process

          +

        Returns DocumentCombinerEngine

        Properties

        baseDocument: JsonDocumentLike
        contributions: Map<string, JsonDocumentLike> = ...
        latestOutput: undefined | JsonDocumentLike

        Methods

        • Add or update one of the contribution documents for the composition process

          Parameters

          • documentName: string

            Name of the contributed document to combine

          • 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

          -
        • Delete one of the contribution documents for the composition process

          +
        • Delete one of the contribution documents for the composition process

          Parameters

          • documentName: string

            Name of the contributed document to delete

          Returns undefined | object

          Recalculated output document given the remaining other documents

          -
        • Run the document composition process given the starting document and all contributions. Throws if the output document fails to validate properly.

          Returns undefined | JsonDocumentLike

          Recalculated output document given the starting and contributed documents

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

        • Update the starting document for composition process

          +

        Returns JsonDocumentLike

        Returns void

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index 4a1688229f..f2fc84342b 100644 --- a/platform-bible-utils/classes/PlatformEventEmitter.html +++ b/platform-bible-utils/classes/PlatformEventEmitter.html @@ -3,7 +3,7 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

        -

        Type Parameters

        Implements

        Constructors

        Type Parameters

        • T

        Implements

        Constructors

        Properties

        Constructors

        Properties

        isDisposed: boolean = false

        Whether this emitter has been disposed

        -
        lazyEvent?: PlatformEvent<T>

        Event for listeners to subscribe to. Lazy loaded

        -
        subscribe: PlatformEvent<T> = ...

        Subscribes a function to run when this event is emitted.

        +
        lazyEvent?: PlatformEvent<T>

        Event for listeners to subscribe to. Lazy loaded

        +
        subscribe: PlatformEvent<T> = ...

        Subscribes a function to run when this event is emitted.

        Param: callback

        Function to run with the event when it is emitted

        Returns

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

        Alias

        event

        -
        subscriptions?: PlatformEventHandler<T>[]

        All callback functions that will run when this event is emitted. Lazy loaded

        -

        Accessors

        subscriptions?: PlatformEventHandler<T>[]

        All callback functions that will run when this event is emitted. Lazy loaded

        +

        Accessors

        • get event(): PlatformEvent<T>
        • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. Use like const unsubscriber = event(callback)

          Returns PlatformEvent<T>

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

          -

        Methods

        • Disposes of this event, preparing it to release from memory

          -

          Returns Promise<boolean>

        Methods

        • Disposes of this event, preparing it to release from memory

          +

          Returns Promise<boolean>

        • Disposes of this event, preparing it to release from memory. Added here so children can override emit and still call the base functionality.

          -

          Returns Promise<boolean>

        • Runs the subscriptions for the event

          Parameters

          • event: T

            Event data to provide to subscribed callbacks

            -

          Returns void

        • Function that runs the subscriptions for the event. Added here so children can override emit +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index 1dcba9bcce..2ad1e42da3 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,11 +1,11 @@ UnsubscriberAsyncList | platform-bible-utils

        Simple collection for UnsubscriberAsync objects that also provides an easy way to run them.

        -

        Constructors

        Constructors

        Properties

        Methods

        Constructors

        Properties

        name: string = 'Anonymous'
        unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

        Methods

        • Add unsubscribers to the list. Note that duplicates are not added twice.

          +

        Constructors

        Properties

        name: string = 'Anonymous'
        unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

        Methods

        • Run all unsubscribers added to this list and then clear the list.

          +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index e353a0d8a8..7438d161d1 100644 --- a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html +++ b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html @@ -1,4 +1,4 @@ aggregateUnsubscriberAsyncs | platform-bible-utils

        Function aggregateUnsubscriberAsyncs

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index a7dec2c1c0..25bd8bf64d 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

        • Returns an Unsubscriber function that combines all the unsubscribers passed in.

          Parameters

          • unsubscribers: Unsubscriber[]

            All unsubscribers to aggregate into one unsubscriber

          Returns Unsubscriber

          Function that unsubscribes from all passed in unsubscribers when run

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index f609a75750..71233e3dd7 100644 --- a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html +++ b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html @@ -7,4 +7,4 @@ does not exist on this object, it will be considered to be an asynchronous method called on the object returned from getObject.

        Returns T

        A synchronous proxy for the asynchronous object.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index f3de7db66d..73d392dde1 100644 --- a/platform-bible-utils/functions/debounce.html +++ b/platform-bible-utils/functions/debounce.html @@ -3,4 +3,4 @@
      • delay: number = 300

        How much delay in milliseconds after the most recent call to the debounced function to call the function

      • Returns T

        Function that, when called, only calls the function passed in at maximum every delay ms

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index 0fa83bf5a2..c310f329b0 100644 --- a/platform-bible-utils/functions/deepClone.html +++ b/platform-bible-utils/functions/deepClone.html @@ -2,4 +2,4 @@ references between the source and target of property copying operations.

        Type Parameters

        Parameters

        Returns T

        Duplicate copy of obj without any references back to the original one

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index ce86e6b036..fab789118f 100644 --- a/platform-bible-utils/functions/deepEqual.html +++ b/platform-bible-utils/functions/deepEqual.html @@ -15,4 +15,4 @@ CodeSandbox.

        Returns boolean

        True if a and b are deeply equal; false otherwise

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index a55a3b00e8..4144143848 100644 --- a/platform-bible-utils/functions/deserialize.html +++ b/platform-bible-utils/functions/deserialize.html @@ -9,4 +9,4 @@ the object. If a member contains nested objects, the nested objects are transformed before the parent object is. Note that null values are converted into undefined values after the reviver has run.

        -

        Returns any

        Generated using TypeDoc

        \ No newline at end of file +

        Returns any

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index f8bc39b04c..6597b2eea3 100644 --- a/platform-bible-utils/functions/getAllObjectFunctionNames.html +++ b/platform-bible-utils/functions/getAllObjectFunctionNames.html @@ -5,4 +5,4 @@

        Parameters

        Returns Set<string>

        Array of all function names on an object

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index 6168980ccb..1997607c56 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        • Parameters

          • bookNum: number

          Returns number

        Generated using TypeDoc

        \ No newline at end of file +getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        • Parameters

          • bookNum: number

          Returns number

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 90dc2b008e..c7712b7822 100644 --- a/platform-bible-utils/functions/getErrorMessage.html +++ b/platform-bible-utils/functions/getErrorMessage.html @@ -5,4 +5,4 @@ stringify

        Example

        `try {...} catch (e) { logger.info(getErrorMessage(e)) }`
         
        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index 565419da64..03e39317da 100644 --- a/platform-bible-utils/functions/groupBy.html +++ b/platform-bible-utils/functions/groupBy.html @@ -2,4 +2,4 @@

        Type Parameters

        Parameters

        Returns Map<K, T[]>

        Map of keys to groups of values corresponding to each item

        -
      • Type Parameters

        Parameters

        Returns Map<K, V[]>

      • Generated using TypeDoc

        \ No newline at end of file +
      • Type Parameters

        Parameters

        Returns Map<K, V[]>

      • Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 0f07dbc888..7f02447468 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils
        • HTML Encodes the provided string. Thanks to ChatGPT

          Parameters

          • str: string

            String to HTML encode

          Returns string

          HTML-encoded string

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index c6531bccd8..0d4e410770 100644 --- a/platform-bible-utils/functions/isSerializable.html +++ b/platform-bible-utils/functions/isSerializable.html @@ -13,4 +13,4 @@

        We intend to improve this in the future if it becomes important to do so. See JSON.stringify documentation for more information.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index 9a97ac0a9f..1c2f9ca280 100644 --- a/platform-bible-utils/functions/isString.html +++ b/platform-bible-utils/functions/isString.html @@ -1,4 +1,4 @@ isString | platform-bible-utils
        • Determine whether the object is a string

          Parameters

          • o: unknown

            Object to determine if it is a string

          Returns o is string

          True if the object is a string; false otherwise

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index d3744a57c6..edf1a08b3c 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils
        • Collection of functions, objects, and types that are used as helpers in other services.

          -

          Returns string

        Generated using TypeDoc

        \ No newline at end of file +

        Returns string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index cfa7b75b03..7a0bc16961 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file +offsetBook | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index 7c2cab73c8..050c4c6c4e 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

        Function offsetChapter

        Generated using TypeDoc

        \ No newline at end of file +offsetChapter | platform-bible-utils

        Function offsetChapter

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index 692cfcd9eb..9386a45368 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file +offsetVerse | platform-bible-utils

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 670e5c2d6a..df1f882743 100644 --- a/platform-bible-utils/functions/serialize.html +++ b/platform-bible-utils/functions/serialize.html @@ -10,4 +10,4 @@
      • Optional space: string | number

        Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read. See the space parameter of JSON.stringify for more details.

        -
      • Returns string

        Generated using TypeDoc

        \ No newline at end of file +

        Returns string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 10e6bb71e0..6a5d8087cd 100644 --- a/platform-bible-utils/functions/wait.html +++ b/platform-bible-utils/functions/wait.html @@ -1,2 +1,2 @@ wait | platform-bible-utils
        • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

          -

          Parameters

          • ms: number

          Returns Promise<void>

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        Returns Promise<void>

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index 37778509c3..65d8ce4354 100644 --- a/platform-bible-utils/functions/waitForDuration.html +++ b/platform-bible-utils/functions/waitForDuration.html @@ -3,4 +3,4 @@
      • maxWaitTimeInMS: number

        The maximum amount of time to wait for the function to resolve

      • Returns Promise<undefined | Awaited<TResult>>

        Promise that resolves to the resolved value of the function or undefined if it ran longer than the specified wait time

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 6f14a69c2f..62ba36f9a0 100644 --- a/platform-bible-utils/interfaces/BookInfo.html +++ b/platform-bible-utils/interfaces/BookInfo.html @@ -1,4 +1,4 @@ -BookInfo | platform-bible-utils
        interface BookInfo {
            chapters: number;
            fullNames: string[];
            shortName: string;
        }

        Properties

        chapters +BookInfo | platform-bible-utils
        interface BookInfo {
            chapters: number;
            fullNames: string[];
            shortName: string;
        }

        Properties

        chapters: number
        fullNames: string[]
        shortName: string

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        chapters: number
        fullNames: string[]
        shortName: string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index 3dadbd9636..a56f2dd4e7 100644 --- a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html +++ b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | platform-bible-utils

        Interface CannotHaveOnDidDispose

        Indicates than an object cannot have an onDidDispose event. Also allows an object to include a dispose function.

        -
        interface CannotHaveOnDidDispose {
            dispose?: UnsubscriberAsync;
            onDidDispose?: undefined;
        }

        Properties

        interface CannotHaveOnDidDispose {
            dispose?: UnsubscriberAsync;
            onDidDispose?: undefined;
        }

        Properties

        Release resources and notify dependent services when tearing down an object

        -
        onDidDispose?: undefined

        Event that emits when dispose is called on an object

        -

        Generated using TypeDoc

        \ No newline at end of file +
        onDidDispose?: undefined

        Event that emits when dispose is called on an object

        +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index 0df3938cca..8a4d00075f 100644 --- a/platform-bible-utils/interfaces/Dispose.html +++ b/platform-bible-utils/interfaces/Dispose.html @@ -1,4 +1,4 @@ Dispose | platform-bible-utils

        Require a dispose function

        -
        interface Dispose {
            dispose: UnsubscriberAsync;
        }

        Implemented by

        Properties

        interface Dispose {
            dispose: UnsubscriberAsync;
        }

        Implemented by

        Properties

        Properties

        Release resources and notify dependent services when tearing down an object

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 3e360e3ba6..c8808314f1 100644 --- a/platform-bible-utils/interfaces/OnDidDispose.html +++ b/platform-bible-utils/interfaces/OnDidDispose.html @@ -1,4 +1,4 @@ OnDidDispose | platform-bible-utils

        Interface OnDidDispose

        Require an onDidDispose event

        -
        interface OnDidDispose {
            onDidDispose: PlatformEvent<void>;
        }

        Properties

        interface OnDidDispose {
            onDidDispose: PlatformEvent<void>;
        }

        Properties

        Properties

        onDidDispose: PlatformEvent<void>

        Event that emits when dispose is called on an object

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index 76e67b1ccc..4df31b7dab 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: number
        chapterNum: number
        verseNum: number

        Generated using TypeDoc

        \ No newline at end of file +

        Properties

        bookNum: number
        chapterNum: number
        verseNum: number

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index ab9ea48bb6..2a33091863 100644 --- a/platform-bible-utils/types/CanHaveOnDidDispose.html +++ b/platform-bible-utils/types/CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | platform-bible-utils

        Type alias CanHaveOnDidDispose<T>

        CanHaveOnDidDispose<T>: Omit<T, "onDidDispose">

        Allow onDidDispose to exist on the type if it was previously disallowed by CannotHaveOnDidDispose

        -

        Type Parameters

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index 559c4d98c0..45077289c9 100644 --- a/platform-bible-utils/types/ColumnsWithHeaders.html +++ b/platform-bible-utils/types/ColumnsWithHeaders.html @@ -1,4 +1,4 @@ ColumnsWithHeaders | platform-bible-utils

        Type alias ColumnsWithHeaders

        ColumnsWithHeaders: {
            isExtensible?: boolean;
            [property: ReferencedItem]: MenuColumnWithHeader;
        }

        Group of columns that can be combined with other columns to form a multi-column menu

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index 72c9b47cfe..c1ffe0bafa 100644 --- a/platform-bible-utils/types/DocumentCombinerOptions.html +++ b/platform-bible-utils/types/DocumentCombinerOptions.html @@ -7,4 +7,4 @@ contributed documents. If false, then throw when duplicate properties are seen in contributed documents. -

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/Groups.html b/platform-bible-utils/types/Groups.html index cfdae4d6c2..8406e9db8f 100644 --- a/platform-bible-utils/types/Groups.html +++ b/platform-bible-utils/types/Groups.html @@ -1,4 +1,4 @@ Groups | platform-bible-utils

        Group of menu items that can be combined with other groups to form a single menu/submenu. Groups are separated using a line within the menu/submenu.

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index 686d20dae9..9b8216f7fe 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: {
            [key: string]: unknown;
        }

        Type declaration

        • [key: string]: unknown

        Generated using TypeDoc

        \ No newline at end of file +JsonDocumentLike | platform-bible-utils

        Type alias JsonDocumentLike

        JsonDocumentLike: {
            [key: string]: unknown;
        }

        Type declaration

        • [key: string]: unknown

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index f89753ec5e..ca0cd83679 100644 --- a/platform-bible-utils/types/LocalizeKey.html +++ b/platform-bible-utils/types/LocalizeKey.html @@ -1,2 +1,2 @@ LocalizeKey | platform-bible-utils

        Type alias LocalizeKey

        LocalizeKey: `%${string}%`

        Identifier for a string that will be localized in a menu based on the user's UI language

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index b1df099034..80d3ea4385 100644 --- a/platform-bible-utils/types/MenuColumnWithHeader.html +++ b/platform-bible-utils/types/MenuColumnWithHeader.html @@ -1,3 +1,3 @@ MenuColumnWithHeader | platform-bible-utils

        Type alias MenuColumnWithHeader

        MenuColumnWithHeader: OrderedExtensibleContainer & {
            label: LocalizeKey;
        }

        Column that includes header text in a menu

        Type declaration

        • label: LocalizeKey

          Key that represents the text of the header text of the column

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index 0740d2873d..7481ec72d5 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInColumn.html +++ b/platform-bible-utils/types/MenuGroupDetailsInColumn.html @@ -1,3 +1,3 @@ MenuGroupDetailsInColumn | platform-bible-utils

        Type alias MenuGroupDetailsInColumn

        MenuGroupDetailsInColumn: OrderedExtensibleContainer & {
            column: ReferencedItem;
        }

        Group of menu items that belongs in a column

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index d85f3dcbb5..dbdf905c18 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html +++ b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html @@ -1,3 +1,3 @@ MenuGroupDetailsInSubMenu | platform-bible-utils

        Type alias MenuGroupDetailsInSubMenu

        MenuGroupDetailsInSubMenu: OrderedExtensibleContainer & {
            menuItem: ReferencedItem;
        }

        Group of menu items that belongs in a submenu

        Type declaration

        • menuItem: ReferencedItem

          ID of menu item hosting the submenu in which this group resides

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index 2b1d5359b8..e5f1779c05 100644 --- a/platform-bible-utils/types/MenuItemBase.html +++ b/platform-bible-utils/types/MenuItemBase.html @@ -3,4 +3,4 @@
      • localizeNotes: string

        Additional information provided by developers to help people who perform localization

      • Optional searchTerms?: LocalizeKey

        Key that represents words the platform should reference when users are searching for menu items

      • Optional tooltip?: LocalizeKey

        Key that represents the text to display if a mouse pointer hovers over the menu item

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index 5b7c831074..25318d014a 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -2,4 +2,4 @@

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index 1e3f089f80..3b1fd60412 100644 --- a/platform-bible-utils/types/MenuItemContainingSubmenu.html +++ b/platform-bible-utils/types/MenuItemContainingSubmenu.html @@ -1,3 +1,3 @@ MenuItemContainingSubmenu | platform-bible-utils

        Type alias MenuItemContainingSubmenu

        MenuItemContainingSubmenu: MenuItemBase & {
            id: ReferencedItem;
        }

        Menu item that hosts a submenu

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index 3a2a13723c..03d20661e8 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -1,3 +1,3 @@ MultiColumnMenu | platform-bible-utils

        Type alias MultiColumnMenu

        MultiColumnMenu: SingleColumnMenu & {
            columns: ColumnsWithHeaders;
        }

        Menu that contains multiple columns with headers

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index 4d262f709f..55ce8d949d 100644 --- a/platform-bible-utils/types/OrderedExtensibleContainer.html +++ b/platform-bible-utils/types/OrderedExtensibleContainer.html @@ -1,2 +1,2 @@ OrderedExtensibleContainer | platform-bible-utils

        Type alias OrderedExtensibleContainer

        OrderedExtensibleContainer: OrderedItem & {
            isExtensible?: boolean;
        }

        Type declaration

        • Optional isExtensible?: boolean

          Determines whether other items can be added to this after it has been defined

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index ccd76dbb96..32e0131f3e 100644 --- a/platform-bible-utils/types/OrderedItem.html +++ b/platform-bible-utils/types/OrderedItem.html @@ -1,2 +1,2 @@ OrderedItem | platform-bible-utils

        Type alias OrderedItem

        OrderedItem: {
            order: number;
        }

        Type declaration

        • order: number

          Relative order of this item compared to other items in the same parent/scope (sorted ascending)

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index e7ce942f01..33966fb9f7 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

        Type Parameters

        Type declaration

        Returns

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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index 2119fe3823..34a632834e 100644 --- a/platform-bible-utils/types/PlatformEventAsync.html +++ b/platform-bible-utils/types/PlatformEventAsync.html @@ -1,3 +1,3 @@ PlatformEventAsync | platform-bible-utils

        Type alias PlatformEventAsync<T>

        PlatformEventAsync<T>: ((callback) => Promise<UnsubscriberAsync>)

        A PapiEvent that subscribes asynchronously and resolves an asynchronous unsubscriber.

        Note: The callback itself is not asynchronous.

        -

        Type Parameters

        • T

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index 857dc3348f..75a536a4b3 100644 --- a/platform-bible-utils/types/PlatformEventHandler.html +++ b/platform-bible-utils/types/PlatformEventHandler.html @@ -1,2 +1,2 @@ PlatformEventHandler | platform-bible-utils

        Type alias PlatformEventHandler<T>

        PlatformEventHandler<T>: ((event) => void)

        Callback function that accepts an event and should run when an event is emitted

        -

        Type Parameters

        • T

        Type declaration

          • (event): void
          • Parameters

            • event: T

            Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index 587a300144..8532c044c9 100644 --- a/platform-bible-utils/types/PlatformMenus.html +++ b/platform-bible-utils/types/PlatformMenus.html @@ -3,4 +3,4 @@
      • defaultWebViewTopMenu: MultiColumnMenu

        Default top menu for web views that don't specify their own

      • mainMenu: MultiColumnMenu

        Top level menu for the application

      • webViewMenus: WebViewMenus

        Menus that apply per web view in the application

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index 4d972521eb..e11051b3c2 100644 --- a/platform-bible-utils/types/ReferencedItem.html +++ b/platform-bible-utils/types/ReferencedItem.html @@ -1,2 +1,2 @@ ReferencedItem | platform-bible-utils

        Type alias ReferencedItem

        ReferencedItem: `${string}.${string}`

        Name of some UI element (i.e., tab, column, group, menu item) or some PAPI object (i.e., command)

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index ba71ce8c63..b737e4383f 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: Groups;
            items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
        }

        Menu that contains a column without a header

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index 0b2516fdc3..a9d02abd3e 100644 --- a/platform-bible-utils/types/Unsubscriber.html +++ b/platform-bible-utils/types/Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | platform-bible-utils

        Type alias Unsubscriber

        Unsubscriber: (() => boolean)

        Function to run to dispose of something. Returns true if successfully unsubscribed

        -

        Type declaration

          • (): boolean
          • Returns boolean

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index 7cca23fbb7..59c863aa01 100644 --- a/platform-bible-utils/types/UnsubscriberAsync.html +++ b/platform-bible-utils/types/UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | platform-bible-utils

        Type alias UnsubscriberAsync

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

        Function to run to dispose of something that runs asynchronously. The promise resolves to true if successfully unsubscribed

        -

        Type declaration

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

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index bd03767602..d1fbcb93c8 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index bb945d548e..de2b4f5855 100644 --- a/platform-bible-utils/types/WebViewMenus.html +++ b/platform-bible-utils/types/WebViewMenus.html @@ -1,3 +1,3 @@ WebViewMenus | platform-bible-utils

        Type alias WebViewMenus

        WebViewMenus: {
            [property: ReferencedItem]: WebViewMenu;
        }

        Menus for all web views

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html index ab1f300f22..164c82fcc9 100644 --- a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html @@ -1 +1 @@ -FIRST_SCR_BOOK_NUM | platform-bible-utils

        Variable FIRST_SCR_BOOK_NUMConst

        FIRST_SCR_BOOK_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file +FIRST_SCR_BOOK_NUM | platform-bible-utils

        Variable FIRST_SCR_BOOK_NUMConst

        FIRST_SCR_BOOK_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html index ea7f47b734..a60ca40b1d 100644 --- a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html @@ -1 +1 @@ -FIRST_SCR_CHAPTER_NUM | platform-bible-utils

        Variable FIRST_SCR_CHAPTER_NUMConst

        FIRST_SCR_CHAPTER_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

        Variable FIRST_SCR_CHAPTER_NUMConst

        FIRST_SCR_CHAPTER_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html index be08060d9d..2ababd579c 100644 --- a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html @@ -1 +1 @@ -FIRST_SCR_VERSE_NUM | platform-bible-utils

        Variable FIRST_SCR_VERSE_NUMConst

        FIRST_SCR_VERSE_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file +FIRST_SCR_VERSE_NUM | platform-bible-utils

        Variable FIRST_SCR_VERSE_NUMConst

        FIRST_SCR_VERSE_NUM: 1 = 1

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html index c08678b6dc..35e50b9749 100644 --- a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html @@ -1 +1 @@ -LAST_SCR_BOOK_NUM | platform-bible-utils

        Variable LAST_SCR_BOOK_NUMConst

        LAST_SCR_BOOK_NUM: number = ...

        Generated using TypeDoc

        \ No newline at end of file +LAST_SCR_BOOK_NUM | platform-bible-utils

        Variable LAST_SCR_BOOK_NUMConst

        LAST_SCR_BOOK_NUM: number = ...

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index fc39e546bf..14b93370a6 100644 --- a/platform-bible-utils/variables/menuDocumentSchema.html +++ b/platform-bible-utils/variables/menuDocumentSchema.html @@ -1,2 +1,2 @@ menuDocumentSchema | platform-bible-utils

        Variable menuDocumentSchemaConst

        menuDocumentSchema: {
            $defs: {
                columnsWithHeaders: {
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            additionalProperties: boolean;
                            description: string;
                            properties: {
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                                localizeNotes: {
                                    description: string;
                                    type: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                    };
                    properties: {
                        isExtensible: {
                            description: string;
                            type: string;
                        };
                    };
                    type: string;
                };
                groupsAndItems: {
                    description: string;
                    properties: {
                        groups: {
                            $ref: string;
                            description: string;
                        };
                        items: {
                            description: string;
                            items: {
                                $ref: string;
                            };
                            type: string;
                            uniqueItems: boolean;
                        };
                    };
                    required: string[];
                    type: string;
                };
                localizeKey: {
                    description: string;
                    pattern: string;
                    type: string;
                };
                menuGroups: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            description: string;
                            oneOf: ({
                                additionalProperties: boolean;
                                properties: {
                                    column: {
                                        $ref: string;
                                        description: string;
                                    };
                                    isExtensible: {
                                        description: string;
                                        type: string;
                                    };
                                    menuItem?: undefined;
                                    order: {
                                        description: string;
                                        type: string;
                                    };
                                };
                                required: string[];
                            } | {
                                additionalProperties: boolean;
                                properties: {
                                    column?: undefined;
                                    isExtensible: {
                                        description: string;
                                        type: string;
                                    };
                                    menuItem: {
                                        $ref: string;
                                        description: string;
                                    };
                                    order: {
                                        description: string;
                                        type: string;
                                    };
                                };
                                required: string[];
                            })[];
                            type: string;
                        };
                    };
                    type: string;
                };
                menuItem: {
                    description: string;
                    oneOf: ({
                        properties: {
                            command?: undefined;
                            iconPathAfter?: undefined;
                            iconPathBefore?: undefined;
                            id: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                    } | {
                        properties: {
                            command: {
                                $ref: string;
                                description: string;
                            };
                            iconPathAfter: {
                                description: string;
                                type: string;
                            };
                            iconPathBefore: {
                                description: string;
                                type: string;
                            };
                            id?: undefined;
                        };
                        required: string[];
                    })[];
                    properties: {
                        group: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        localizeNotes: {
                            description: string;
                            type: string;
                        };
                        order: {
                            description: string;
                            type: string;
                        };
                        searchTerms: {
                            $ref: string;
                            description: string;
                        };
                        tooltip: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                    unevaluatedProperties: boolean;
                };
                menusForOneWebView: {
                    additionalProperties: boolean;
                    description: string;
                    properties: {
                        contextMenu: {
                            $ref: string;
                            description: string;
                        };
                        includeDefaults: {
                            description: string;
                            type: string;
                        };
                        topMenu: {
                            $ref: string;
                            description: string;
                        };
                    };
                    type: string;
                };
                multiColumnMenu: {
                    allOf: ({
                        $ref: string;
                        properties?: undefined;
                        required?: undefined;
                    } | {
                        $ref?: undefined;
                        properties: {
                            columns: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                    })[];
                    description: string;
                    type: string;
                    unevaluatedProperties: boolean;
                };
                referencedItem: {
                    description: string;
                    pattern: string;
                    type: string;
                };
                singleColumnMenu: {
                    allOf: {
                        $ref: string;
                    }[];
                    description: string;
                    type: string;
                    unevaluatedProperties: boolean;
                };
            };
            additionalProperties: boolean;
            properties: {
                defaultWebViewContextMenu: {
                    $ref: string;
                    description: string;
                };
                defaultWebViewTopMenu: {
                    $ref: string;
                    description: string;
                };
                mainMenu: {
                    $ref: string;
                    description: string;
                };
                webViewMenus: {
                    additionalProperties: boolean;
                    description: string;
                    patternProperties: {
                        ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        };
                    };
                    type: string;
                };
            };
            required: string[];
            title: string;
            type: string;
        } = ...

        JSON schema object that aligns with the PlatformMenus type

        -

        Type declaration

        • $defs: {
              columnsWithHeaders: {
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          additionalProperties: boolean;
                          description: string;
                          properties: {
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              localizeNotes: {
                                  description: string;
                                  type: string;
                              };
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                  };
                  properties: {
                      isExtensible: {
                          description: string;
                          type: string;
                      };
                  };
                  type: string;
              };
              groupsAndItems: {
                  description: string;
                  properties: {
                      groups: {
                          $ref: string;
                          description: string;
                      };
                      items: {
                          description: string;
                          items: {
                              $ref: string;
                          };
                          type: string;
                          uniqueItems: boolean;
                      };
                  };
                  required: string[];
                  type: string;
              };
              localizeKey: {
                  description: string;
                  pattern: string;
                  type: string;
              };
              menuGroups: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          description: string;
                          oneOf: ({
                              additionalProperties: boolean;
                              properties: {
                                  column: {
                                      $ref: string;
                                      description: string;
                                  };
                                  isExtensible: {
                                      description: string;
                                      type: string;
                                  };
                                  menuItem?: undefined;
                                  order: {
                                      description: string;
                                      type: string;
                                  };
                              };
                              required: string[];
                          } | {
                              additionalProperties: boolean;
                              properties: {
                                  column?: undefined;
                                  isExtensible: {
                                      description: string;
                                      type: string;
                                  };
                                  menuItem: {
                                      $ref: string;
                                      description: string;
                                  };
                                  order: {
                                      description: string;
                                      type: string;
                                  };
                              };
                              required: string[];
                          })[];
                          type: string;
                      };
                  };
                  type: string;
              };
              menuItem: {
                  description: string;
                  oneOf: ({
                      properties: {
                          command?: undefined;
                          iconPathAfter?: undefined;
                          iconPathBefore?: undefined;
                          id: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                  } | {
                      properties: {
                          command: {
                              $ref: string;
                              description: string;
                          };
                          iconPathAfter: {
                              description: string;
                              type: string;
                          };
                          iconPathBefore: {
                              description: string;
                              type: string;
                          };
                          id?: undefined;
                      };
                      required: string[];
                  })[];
                  properties: {
                      group: {
                          $ref: string;
                          description: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      localizeNotes: {
                          description: string;
                          type: string;
                      };
                      order: {
                          description: string;
                          type: string;
                      };
                      searchTerms: {
                          $ref: string;
                          description: string;
                      };
                      tooltip: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
                  type: string;
                  unevaluatedProperties: boolean;
              };
              menusForOneWebView: {
                  additionalProperties: boolean;
                  description: string;
                  properties: {
                      contextMenu: {
                          $ref: string;
                          description: string;
                      };
                      includeDefaults: {
                          description: string;
                          type: string;
                      };
                      topMenu: {
                          $ref: string;
                          description: string;
                      };
                  };
                  type: string;
              };
              multiColumnMenu: {
                  allOf: ({
                      $ref: string;
                      properties?: undefined;
                      required?: undefined;
                  } | {
                      $ref?: undefined;
                      properties: {
                          columns: {
                              $ref: string;
                              description: string;
                          };
                      };
                      required: string[];
                  })[];
                  description: string;
                  type: string;
                  unevaluatedProperties: boolean;
              };
              referencedItem: {
                  description: string;
                  pattern: string;
                  type: string;
              };
              singleColumnMenu: {
                  allOf: {
                      $ref: string;
                  }[];
                  description: string;
                  type: string;
                  unevaluatedProperties: boolean;
              };
          }
          • columnsWithHeaders: {
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        additionalProperties: boolean;
                        description: string;
                        properties: {
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            localizeNotes: {
                                description: string;
                                type: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                        type: string;
                    };
                };
                properties: {
                    isExtensible: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            }
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      additionalProperties: boolean;
                      description: string;
                      properties: {
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          localizeNotes: {
                              description: string;
                              type: string;
                          };
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                      type: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    additionalProperties: boolean;
                    description: string;
                    properties: {
                        isExtensible: {
                            description: string;
                            type: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                        localizeNotes: {
                            description: string;
                            type: string;
                        };
                        order: {
                            description: string;
                            type: string;
                        };
                    };
                    required: string[];
                    type: string;
                }
                • additionalProperties: boolean
                • description: string
                • properties: {
                      isExtensible: {
                          description: string;
                          type: string;
                      };
                      label: {
                          $ref: string;
                          description: string;
                      };
                      localizeNotes: {
                          description: string;
                          type: string;
                      };
                      order: {
                          description: string;
                          type: string;
                      };
                  }
                  • isExtensible: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • label: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • localizeNotes: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • order: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                • required: string[]
                • type: string
            • properties: {
                  isExtensible: {
                      description: string;
                      type: string;
                  };
              }
              • isExtensible: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
            • type: string
          • groupsAndItems: {
                description: string;
                properties: {
                    groups: {
                        $ref: string;
                        description: string;
                    };
                    items: {
                        description: string;
                        items: {
                            $ref: string;
                        };
                        type: string;
                        uniqueItems: boolean;
                    };
                };
                required: string[];
                type: string;
            }
            • description: string
            • properties: {
                  groups: {
                      $ref: string;
                      description: string;
                  };
                  items: {
                      description: string;
                      items: {
                          $ref: string;
                      };
                      type: string;
                      uniqueItems: boolean;
                  };
              }
              • groups: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • items: {
                    description: string;
                    items: {
                        $ref: string;
                    };
                    type: string;
                    uniqueItems: boolean;
                }
                • description: string
                • items: {
                      $ref: string;
                  }
                  • $ref: string
                • type: string
                • uniqueItems: boolean
            • required: string[]
            • type: string
          • localizeKey: {
                description: string;
                pattern: string;
                type: string;
            }
            • description: string
            • pattern: string
            • type: string
          • menuGroups: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        description: string;
                        oneOf: ({
                            additionalProperties: boolean;
                            properties: {
                                column: {
                                    $ref: string;
                                    description: string;
                                };
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem?: undefined;
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        } | {
                            additionalProperties: boolean;
                            properties: {
                                column?: undefined;
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem: {
                                    $ref: string;
                                    description: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        })[];
                        type: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      description: string;
                      oneOf: ({
                          additionalProperties: boolean;
                          properties: {
                              column: {
                                  $ref: string;
                                  description: string;
                              };
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              menuItem?: undefined;
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                      } | {
                          additionalProperties: boolean;
                          properties: {
                              column?: undefined;
                              isExtensible: {
                                  description: string;
                                  type: string;
                              };
                              menuItem: {
                                  $ref: string;
                                  description: string;
                              };
                              order: {
                                  description: string;
                                  type: string;
                              };
                          };
                          required: string[];
                      })[];
                      type: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    description: string;
                    oneOf: ({
                        additionalProperties: boolean;
                        properties: {
                            column: {
                                $ref: string;
                                description: string;
                            };
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            menuItem?: undefined;
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                    } | {
                        additionalProperties: boolean;
                        properties: {
                            column?: undefined;
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            menuItem: {
                                $ref: string;
                                description: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                    })[];
                    type: string;
                }
                • description: string
                • oneOf: ({
                      additionalProperties: boolean;
                      properties: {
                          column: {
                              $ref: string;
                              description: string;
                          };
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          menuItem?: undefined;
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                  } | {
                      additionalProperties: boolean;
                      properties: {
                          column?: undefined;
                          isExtensible: {
                              description: string;
                              type: string;
                          };
                          menuItem: {
                              $ref: string;
                              description: string;
                          };
                          order: {
                              description: string;
                              type: string;
                          };
                      };
                      required: string[];
                  })[]
                • type: string
            • type: string
          • menuItem: {
                description: string;
                oneOf: ({
                    properties: {
                        command?: undefined;
                        iconPathAfter?: undefined;
                        iconPathBefore?: undefined;
                        id: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                } | {
                    properties: {
                        command: {
                            $ref: string;
                            description: string;
                        };
                        iconPathAfter: {
                            description: string;
                            type: string;
                        };
                        iconPathBefore: {
                            description: string;
                            type: string;
                        };
                        id?: undefined;
                    };
                    required: string[];
                })[];
                properties: {
                    group: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    localizeNotes: {
                        description: string;
                        type: string;
                    };
                    order: {
                        description: string;
                        type: string;
                    };
                    searchTerms: {
                        $ref: string;
                        description: string;
                    };
                    tooltip: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
                unevaluatedProperties: boolean;
            }
            • description: string
            • oneOf: ({
                  properties: {
                      command?: undefined;
                      iconPathAfter?: undefined;
                      iconPathBefore?: undefined;
                      id: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
              } | {
                  properties: {
                      command: {
                          $ref: string;
                          description: string;
                      };
                      iconPathAfter: {
                          description: string;
                          type: string;
                      };
                      iconPathBefore: {
                          description: string;
                          type: string;
                      };
                      id?: undefined;
                  };
                  required: string[];
              })[]
            • properties: {
                  group: {
                      $ref: string;
                      description: string;
                  };
                  label: {
                      $ref: string;
                      description: string;
                  };
                  localizeNotes: {
                      description: string;
                      type: string;
                  };
                  order: {
                      description: string;
                      type: string;
                  };
                  searchTerms: {
                      $ref: string;
                      description: string;
                  };
                  tooltip: {
                      $ref: string;
                      description: string;
                  };
              }
              • group: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • label: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • localizeNotes: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • order: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • searchTerms: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • tooltip: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • required: string[]
            • type: string
            • unevaluatedProperties: boolean
          • menusForOneWebView: {
                additionalProperties: boolean;
                description: string;
                properties: {
                    contextMenu: {
                        $ref: string;
                        description: string;
                    };
                    includeDefaults: {
                        description: string;
                        type: string;
                    };
                    topMenu: {
                        $ref: string;
                        description: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • properties: {
                  contextMenu: {
                      $ref: string;
                      description: string;
                  };
                  includeDefaults: {
                      description: string;
                      type: string;
                  };
                  topMenu: {
                      $ref: string;
                      description: string;
                  };
              }
              • contextMenu: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
              • includeDefaults: {
                    description: string;
                    type: string;
                }
                • description: string
                • type: string
              • topMenu: {
                    $ref: string;
                    description: string;
                }
                • $ref: string
                • description: string
            • type: string
          • multiColumnMenu: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        columns: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                })[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            }
            • allOf: ({
                  $ref: string;
                  properties?: undefined;
                  required?: undefined;
              } | {
                  $ref?: undefined;
                  properties: {
                      columns: {
                          $ref: string;
                          description: string;
                      };
                  };
                  required: string[];
              })[]
            • description: string
            • type: string
            • unevaluatedProperties: boolean
          • referencedItem: {
                description: string;
                pattern: string;
                type: string;
            }
            • description: string
            • pattern: string
            • type: string
          • singleColumnMenu: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            }
            • allOf: {
                  $ref: string;
              }[]
            • description: string
            • type: string
            • unevaluatedProperties: boolean
        • additionalProperties: boolean
        • properties: {
              defaultWebViewContextMenu: {
                  $ref: string;
                  description: string;
              };
              defaultWebViewTopMenu: {
                  $ref: string;
                  description: string;
              };
              mainMenu: {
                  $ref: string;
                  description: string;
              };
              webViewMenus: {
                  additionalProperties: boolean;
                  description: string;
                  patternProperties: {
                      ^[\w\-]+\.[\w\-]+$: {
                          $ref: string;
                      };
                  };
                  type: string;
              };
          }
          • defaultWebViewContextMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • defaultWebViewTopMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • mainMenu: {
                $ref: string;
                description: string;
            }
            • $ref: string
            • description: string
          • webViewMenus: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            }
            • additionalProperties: boolean
            • description: string
            • patternProperties: {
                  ^[\w\-]+\.[\w\-]+$: {
                      $ref: string;
                  };
              }
              • ^[\w\-]+\.[\w\-]+$: {
                    $ref: string;
                }
                • $ref: string
            • type: string
        • required: string[]
        • title: string
        • type: string

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file