From 7f8c7bfe2f8c643544311c05eb4fce24e71dc0eb Mon Sep 17 00:00:00 2001 From: tjcouch-sil <104016682+tjcouch-sil@users.noreply.github.com> Date: Tue, 20 Feb 2024 22:28:25 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20github-pages=20from=20@=20para?= =?UTF-8?q?next/paranext-core@4fe0c41179757ae95e91a3862eb085d5705a7955=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 +- ...ider_engine_model_.DataProviderEngine.html | 4 +- ..._network_event_emitter_model_.default.html | 20 +++--- ...gine_model_.ProjectDataProviderEngine.html | 10 +-- ...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 +- ...oks_use_project_setting_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 +- ...ookup_service_.filterProjectsMetadata.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 +- ...api_shared_types_.ProjectSettingTypes.html | 6 +- ...red_types_.ProjectStorageInterpreters.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 +- ...el_.IProjectDataProviderEngineFactory.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 +- ...ervice_model_.IProjectSettingsService.html | 6 +- ...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 +- ..._papi_hooks_use_project_setting_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 +- ...ls_project_storage_interpreter_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 +- ...ed_services_project_settings_service_.html | 2 +- ...vices_project_settings_service_model_.html | 2 +- .../_shared_services_settings_service_.html | 2 +- ...ared_services_settings_service_model_.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 +- ...pi_shared_types_.IProjectDataProvider.html | 2 +- ...red_types_.IProjectStorageInterpreter.html | 2 +- ...ared_types_.NotesOnlyProjectDataTypes.html | 2 +- ...pi_shared_types_.PlaceholderDataTypes.html | 2 +- .../_papi_shared_types_.ProjectDataTypes.html | 2 +- ...api_shared_types_.ProjectSettingNames.html | 2 +- ...shared_types_.ProjectStorageDataTypes.html | 2 +- ...red_types_.ProjectStorageProjectTypes.html | 2 +- ...types_.ProjectStorageSettingDataScope.html | 2 +- .../_papi_shared_types_.ProjectTypes.html | 2 +- .../_papi_shared_types_.SettingNames.html | 2 +- .../_papi_shared_types_.StuffDataTypes.html | 2 +- ...ojectDataProviderEngineSettingMethods.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 +- ...ition_model_.ProjectDialogOptionsBase.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 +- ...ine_model_.IProjectDataProviderEngine.html | 2 +- ...model_.ProjectDataProviderEngineTypes.html | 2 +- ...ta_provider_model_.ExtensionDataScope.html | 2 +- ...ider_model_.MandatoryProjectDataTypes.html | 2 +- ...ataProviderEngineExtensionDataMethods.html | 4 +- ...oject_metadata_model_.ProjectMetadata.html | 2 +- ...model_.DefaultProjectStorageDataTypes.html | 2 +- ...del_.MandatoryProjectStorageDataTypes.html | 2 +- ...del_.ProjectStorageExtensionDataScope.html | 2 +- ...model_.ProjectStorageProjectDataScope.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 +- ...e_model_.ProjectMetadataFilterOptions.html | 2 +- ...l_.SimultaneousProjectSettingsChanges.html | 2 +- ...ttings_service_model_.AllSettingsData.html | 2 +- ...tings_service_model_.ISettingsService.html | 8 +-- ...tings_service_model_.SettingDataTypes.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 +- ...pi_backend_.ProjectDataProviderEngine.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 +- .../__papi_backend_.projectSettings.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 +- ...ces_project_settings_service_.default.html | 2 +- ...ojectSettingsServiceNetworkObjectName.html | 2 +- ...ed_services_settings_service_.default.html | 2 +- ...odel_.settingsServiceDataProviderName.html | 2 +- ...e_model_.settingsServiceObjectToProxy.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 +++--- platform-bible-utils/classes/Mutex.html | 2 +- platform-bible-utils/classes/MutexMap.html | 4 +- .../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 +- 537 files changed, 744 insertions(+), 744 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 b700f9d86d..e7c442fb6d 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 9842ebf2df..c1adad59ec 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 254b57a7bc..0f732592ab 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 e248810059..3118e59ea3 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 db1f027ea1..a0a4e57f03 100644 --- a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html @@ -2,7 +2,7 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

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

-

Implements

Constructors

Implements

  • XMLHttpRequest

Constructors

Properties

Constructors

Properties

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

Type declaration

    • (): void
    • Returns void

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

Type declaration

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

      • K extends keyof XMLHttpRequestEventMap

      Parameters

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

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders: (() => string)

Type declaration

    • (): string
    • Returns string

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

Type declaration

    • (name): null | string
    • Parameters

      • name: string

      Returns null | string

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

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

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

      Returns void

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void
    • Parameters

      • mime: string

      Returns void

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

Type declaration

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

      • K extends keyof XMLHttpRequestEventMap

      Parameters

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

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

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

Type declaration

    • (body?): void
    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

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

Type declaration

    • (name, value): void
    • Parameters

      • name: string
      • value: string

      Returns void

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

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

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

Type declaration

    • (): void
    • Returns void

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

Type declaration

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

      • K extends keyof XMLHttpRequestEventMap

      Parameters

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

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | AddEventListenerOptions

      Returns void

dispatchEvent: ((event) => boolean)

Type declaration

    • (event): boolean
    • Parameters

      • event: Event

      Returns boolean

getAllResponseHeaders: (() => string)

Type declaration

    • (): string
    • Returns string

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

Type declaration

    • (name): null | string
    • Parameters

      • name: string

      Returns null | string

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: XMLHttpRequest
      • ev: ProgressEvent<EventTarget>

      Returns any

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

Type declaration

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

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

      Returns void

overrideMimeType: ((mime) => void)

Type declaration

    • (mime): void
    • Parameters

      • mime: string

      Returns void

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

Type declaration

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

      • K extends keyof XMLHttpRequestEventMap

      Parameters

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

            • this: XMLHttpRequest
            • ev: XMLHttpRequestEventMap[K]

            Returns any

      • Optional options: boolean | EventListenerOptions

      Returns void

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

Type declaration

    • (body?): void
    • Parameters

      • Optional body: null | Document | XMLHttpRequestBodyInit

      Returns void

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

Type declaration

    • (name, value): void
    • Parameters

      • name: string
      • value: string

      Returns void

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

Generated using TypeDoc

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

See

IDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Type Parameters

Hierarchy (view full)

Implements

Constructors

Methods

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Methods

Generated using TypeDoc

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

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

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

-

Type Parameters

Hierarchy

Constructors

Type Parameters

  • T

Hierarchy

  • PlatformEventEmitter<T>
    • default

Constructors

Properties

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

Constructors

Properties

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

Type declaration

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

emit: ((event) => void)

Type declaration

    • (event): void
    • Parameters

      • event: T

      Returns void

networkDisposer: any

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

-
networkSubscriber: any

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

-
subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+
    • (): void
    • Returns void

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

Properties

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

Type declaration

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

emit: ((event) => void)

Type declaration

    • (event): void
    • Parameters

      • event: T

      Returns void

networkDisposer: any

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

+
networkSubscriber: any

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

+
subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

Param: callback

Function to run with the event when it is emitted

Returns

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

Alias

event

-

Accessors

Accessors

Methods

Methods

Generated using TypeDoc

\ No newline at end of file +

Returns void

Generated using TypeDoc

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

See

IProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

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

Methods

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

  • projectStorageInterpreterId: string

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

Properties

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

Methods

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html index ac6ad3d2a8..ce31a40b18 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 31bf0ccda6..7959528e67 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 7ba1fd6a26..f2eb6a40c8 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 a8e15fb083..005f4092ad 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 1aba43f16d..1c358e8430 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 ba8e2e959b..ab5a0779cc 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 774199e400..ff84dabdef 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 f5f89f3dce..bcfefe1ac2 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 bc142a333f..3102ec0ff1 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 3bc2b35b0f..a81badfb1c 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 3c26fcdc33..442ff786f2 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 bb8d20d3f0..dd4c9c7247 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 76683abc29..b99603e339 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 812c0162c5..7f248d4c30 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 91a68b711f..376f32c55c 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 183c3ea5e7..04d4fd7832 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 72056cab81..014fcab76f 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 6b368c95fd..ebf1e04f51 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 024ae27514..352c2d3770 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 58c748653d..d239cd80df 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 b94c8990a3..fce6f4b860 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 8940893f87..3879dd4682 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 e671f4501c..49106cad51 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 f418c8f2e8..d375e118ca 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 b56a4b4468..4a2fcf23c5 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 89bf7eb046..f7f5666b0f 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 e2609218c0..66a4591982 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 4a7cbef168..6e578eb43b 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 7f1e0144be..cb8b9beedf 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 a145b32464..0e436157dd 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 3986e83831..ad239ae78b 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 39990a4988..0f032927bd 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 948cc6934c..b7a0f50bcf 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 ca784b6728..88a03344f3 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 2f069b8eff..9a84f34dcc 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html @@ -37,4 +37,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -

    Type Parameters

    Parameters

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    Generated using TypeDoc

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

    Returns undefined | ProjectDataProviders[ProjectType]

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Throws

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html index 76502edcac..4e4bfe3ce8 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html @@ -18,4 +18,4 @@

    Throws

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html index baf28f712f..1c2b10ebf5 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 a00a3603f3..2c1182287d 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 8bd7e0655e..7073166e5f 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 2b68dbe0ec..a0279867ec 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 974608bbb2..305dc5d3b9 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 bfcc1a3796..2bc01b01d2 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 fcd210f6e6..002afe6914 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 37053de468..8ca6304838 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 134ff27b19..4bfbe56c91 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 bf45e21fac..fda1d5d301 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 e1f4c274de..9c8d34048a 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 7f87669480..c586af72f9 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 82e4af7964..b93c407a4d 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 da9e911b27..b81f0a4789 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 b9996ef061..46ac7ae40e 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 529ee3cda7..9e7d80dde8 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 effe94a747..2920546bfe 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 0f2b3dee1f..2882b475ad 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 0ac36abb88..c8efdf57ef 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 2fadd396c7..b2e6e6a073 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 328f92f8b7..f2ecf75d06 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 759fbe3dc3..cf4ef882e5 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 ea6598c9f4..3f564d184b 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 86a839f0de..b56ccddda6 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 e20e01197d..989ff5cba5 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 55906722b1..15a2fe0bd8 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 ceecab5619..25b6bd0a91 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 b81f6e62e6..3436ef4631 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 ff6bddaf47..2505009ac4 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 700728461b..38f73f066f 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 a05da334e5..07900df234 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns Promise<Dispose>

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index 4050b51ead..83b776664c 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 e2f8ce0884..656115e3e2 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 1d6bfb45aa..6cb5236704 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 54389a47f9..635a674a8a 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 ef76999e00..5982554fb7 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 6b7592675c..e4eeee8b41 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 07e78600a7..29f725255c 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 1592499990..723e546d9d 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 743b08565d..c51e62fb1d 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 be6a24e839..1a9e028886 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 9b11e2c15e..76824d1f69 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 cfe2246461..cb2cecdb77 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 27cba16a5b..8da32b96ce 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 122905f64f..6d6c036a5e 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 44b09bf877..1b9be4fc90 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 4bbe850e8f..efee14d852 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 716d3d3099..c10c72c4d3 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 437f42623e..edc904bc88 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 eb885bf853..b2b3888307 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 bbae58d4ea..ac46fb6e79 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 aba0f211d5..45d848278d 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 a822776d53..6698813190 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 b703ae8824..8b9a922edb 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 36e41fa4c2..5c207607ee 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviders.html @@ -16,6 +16,6 @@ are adding a Project Data Provider type for the MyExtensionProjectTypeName projectType):

    Example

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

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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Generated using TypeDoc

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

    Example

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

    Properties

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

    Properties

    platform.fullName: string

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

    Example

    'World English Bible'
     
    -
    platform.language: string

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

    platform.language: string

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

    Example

    'English'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Example

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

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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Generated using TypeDoc

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

    Example

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

    Properties

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

    Properties

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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

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

    Generated using TypeDoc

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

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

    Keys should be dialog names, and values should be DialogDataTypes

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

    -

    Properties

    Properties

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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html index 99c3bd1e7a..e0bd6e4357 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 f2afab4486..52f622cc0b 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 e478507e0c..f838e1b21e 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html @@ -1,3 +1,3 @@ TabLayout | papi-dts

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type: "tab"

    Generated using TypeDoc

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

    Properties

    Properties

    type: "tab"

    Generated using TypeDoc

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

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

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

    Type Parameters

    Methods

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

    Type Parameters

    Methods

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

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

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

    Returns ProjectDataProviderEngineTypes[ProjectType]

    A IProjectDataProviderEngine for the project passed in

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.DisposableWebViewProvider.html index a3ec878acb..d38f14621f 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 cad63b462a..5181cdec2f 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 2041b64936..bee6c5b119 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 24a2ecffd5..01fc29e19b 100644 --- a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html +++ b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html @@ -1,4 +1,4 @@ -DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method): void;
                (target, member): void;
            };
            ignore: {
                (method): void;
                (target, member): void;
            };
        };
        get: (<DataProviderName>(providerName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName) => boolean);
        registerEngine: (<DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

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

    Properties

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

    See

    IDataProviderEngine for more information on extending this class.

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

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

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

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

    Type declaration

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

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

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

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

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

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

    Get a data provider that has previously been set up

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

    Get a data provider that has previously been set up

    Type declaration

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

        Type Parameters

        • DataProviderName extends keyof DataProviders

        Parameters

        Returns Promise<DataProviders[DataProviderName] | undefined>

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

    Param: providerName

    Name of the desired data provider

    Returns

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

    -
    hasKnown: ((providerName) => boolean)

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

    hasKnown: ((providerName) => boolean)

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

    Type declaration

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

        -

        Parameters

        • providerName: string

        Returns boolean

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

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

    Parameters

    • providerName: string

    Returns boolean

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

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

    Type declaration

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

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

        Param: dataProviderAttributes

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

        Returns

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

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Prompt the user for responses with dialogs

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

    Methods

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

    Methods

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

      Parameters

      Returns Promise<undefined | string>

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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index f3e57f3acf..1c3680c5e8 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 79c8e1e1f9..516558085b 100644 --- a/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html +++ b/papi-dts/interfaces/_shared_services_network_connector_interface_.default.html @@ -1,7 +1,7 @@ default | papi-dts

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

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

    Implemented by

    Properties

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

    Implemented by

    Properties

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

    Param: localEventHandler

    Function that handles events from the server

    Param: networkConnectorEventHandlers

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

    Returns

    Promise that resolves with connector info when finished connecting

    -
    connectionStatus: ConnectionStatus

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

    connectionStatus: ConnectionStatus

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

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

    Information about the connector. Populated by the server while connecting

    -

    Type declaration

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

    Disconnects from the connection:

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

    Information about the connector. Populated by the server while connecting

    +

    Type declaration

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

    Disconnects from the connection:

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

      Returns

      Promise that resolves with connector info when finished conne

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

    Returns void

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

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

    Returns void

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

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

    Type declaration

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

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

        Returns

        Promise that resolves with connector info when finished conne

      • event: InternalEvent<T>

        Event to emit on the network

    Returns Promise<void>

    Param: eventType

    Unique network event type for coordinating between processes

    Param: event

    Event to emit on the network

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

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

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

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

    MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

    TODO: Is this necessary?

    Type declaration

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

        MUST RUN AFTER connect() WHEN ITS PROMISE RESOLVES

        TODO: Is this necessary?

        -

        Returns Promise<void>

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

    +

    Returns Promise<void>

    request: InternalRequestHandler

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

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_services_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index 62fed5b32c..b8cab2caac 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 0242d0b0e6..34ab078ae7 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 c4e1f4b5d5..bf1d558eed 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 a77a9d7902..9d484d8ce3 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 77499779d7..22ae09adcc 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 9b0afbcd79..72ee48005f 100644 --- a/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/interfaces/_shared_services_project_lookup_service_model_.ProjectLookupServiceType.html @@ -1,14 +1,14 @@ ProjectLookupServiceType | papi-dts

    Provides metadata for projects known by the platform

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

    Properties

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

    Properties

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

    Provide metadata for all projects found on the local system

    Type declaration

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

        Returns Promise<ProjectMetadata[]>

        ProjectMetadata for all projects stored on the local system

    Returns

    ProjectMetadata for all projects stored on the local system

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

    Look up metadata for a specific project ID

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

    Look up metadata for a specific project ID

    Type declaration

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

        Parameters

        • projectId: string

          ID of the project to load

        Returns Promise<ProjectMetadata>

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

    Param: projectId

    ID of the project to load

    Returns

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

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

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

    Methods

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

    Methods

    Returns Promise<ProjectSettingTypes[ProjectSettingName]>

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

    Throws

    If a default value is not registered for the setting

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

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

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

      @@ -21,4 +21,4 @@
    • allChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    • projectType: keyof ProjectDataProviders

      The projectType for the project whose setting is being changed

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html index 463463401d..764dd41b33 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 76c7c4d1e9..365ba729a3 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 ac3c5819ea..159f52d89f 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 bbae67b3cc..1e51e16f11 100644 --- a/papi-dts/modules/__papi_backend_.html +++ b/papi-dts/modules/__papi_backend_.html @@ -1,4 +1,4 @@ -"@papi/backend" | papi-dts

    Namespace "@papi/backend"

    Index

    Variables

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

    Namespace "@papi/backend"

    Index

    Variables

    DataProviderEngine ProjectDataProviderEngine commands dataProviders diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 938f0973d7..0ea658d0d9 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 0db2ecd78b..31ed6f888c 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 e503ff9bd1..cd6e0fb84b 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 ab8ea29516..5c14282a47 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 a76e4c6659..89eef62ca0 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 b39c2ad48c..67c08aa73c 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 3e77ffa5ab..0f42ae9aef 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 691a464b55..d964f39d8a 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 e312bbbdb3..593350c97f 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 97bc5085b0..5d84d33766 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 5a385f11da..2ff8cbcd39 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 7675751b28..90cb12f4e9 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 7a8e0273e3..4492ce8266 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 a3cf292ebe..75b45d9903 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 b1f03515f1..5a47166ab1 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 0ad70b9ac2..c8c2efa21b 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 b1728e7a2d..c09f510b0a 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 a2ace7708f..80212d61d0 100644 --- a/papi-dts/modules/_papi_shared_types_.html +++ b/papi-dts/modules/_papi_shared_types_.html @@ -1,4 +1,4 @@ -"papi-shared-types" | papi-dts

    Namespace "papi-shared-types"

    Index

    Interfaces

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

    Namespace "papi-shared-types"

    Index

    Interfaces

    CommandHandlers DataProviders ProjectDataProviders ProjectSettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index c2c62a2b20..ec7b17df60 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 f219a63a35..2007b4ba03 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 019b579bf5..eb18e3d9b0 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 bd64aebcf7..63e643cca3 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 db881821f7..dca5200ddd 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 c472b34149..31fd30a25b 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 fe6c09c349..d5440471e6 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 b265c70c6b..45705d73d5 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 fc41f1cfd7..c97b4414d0 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 0e36334d20..5c24abbba0 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 0469440f74..ae9a7b0a50 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

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

    Index

    Functions

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

    Generated using TypeDoc

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

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

    Index

    Functions

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html index 968825b1cd..8b5d3424a3 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 d28f6db70b..92ef295238 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 26bafc8187..a6cbf5ff5b 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 b0f405b9e8..ecf1862ed0 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 4fb249a71c..161d472ead 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 4964854338..1e3ddc4481 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 81d6ecf470..f10350be7b 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 98e7a56a56..42de248431 100644 --- a/papi-dts/modules/_shared_models_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider-engine.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    Type Aliases

    DataProviderEngineNotifyUpdate WithNotifyUpdate default diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index 539e94315c..90903e3788 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 7135fc45dc..1502213992 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 423df9bb6d..43a538e610 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 b00312b006..e50ccaa34a 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 9c15971a71..889dae054a 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 c2306c20b5..0a30421eaf 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 3616ffe001..b59d5e0ac5 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 5dda2028fc..7674f4a103 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    Interfaces

    Type Aliases

    IProjectDataProviderEngine ProjectDataProviderEngineTypes diff --git a/papi-dts/modules/_shared_models_project_data_provider_model_.html b/papi-dts/modules/_shared_models_project_data_provider_model_.html index cbe5e034f7..6be504060e 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider.model" | papi-dts

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

    Index

    Type Aliases

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

    Generated using TypeDoc

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

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

    Index

    Type Aliases

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html b/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html index 454fa7a595..f0acd51dba 100644 --- a/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html +++ b/papi-dts/modules/_shared_models_project_storage_interpreter_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-storage-interpreter.model" | papi-dts

    Namespace "shared/models/project-storage-interpreter.model"

    Index

    Type Aliases

    DefaultProjectStorageDataTypes +"shared/models/project-storage-interpreter.model" | papi-dts

    Namespace "shared/models/project-storage-interpreter.model"

    Index

    Type Aliases

    DefaultProjectStorageDataTypes MandatoryProjectStorageDataTypes ProjectStorageExtensionDataScope ProjectStorageProjectDataScope diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index 71658edd32..8a46619ef5 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 abbe5e9d01..f25e1ee5e8 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 bc0cbf1ccb..deb9ee902d 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 6c4be75f4b..a60ae39f1b 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 8f2d6551a5..cb89fc7f20 100644 --- a/papi-dts/modules/_shared_services_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/data-provider.service" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    Variables

    Functions

    getByType registerEngineByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index 2fcff475be..8e93225b89 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 7b62b34689..e3220aad0a 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 db5d31b284..ead5a6f5ef 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 10dca38112..2892b9a91f 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 4d3ce82470..8da6683f91 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 503c02e19e..246365ab70 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 a6f0e61378..86aaf94b60 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 efe6605ab4..a07e9e9b52 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 0060b6597d..f40cabcf0d 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 02a149af07..93f4eac577 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 7c6d1a26c8..95ed4c4144 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 d31355da98..d2e338ae80 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 d0a9ce5c5d..b840db6426 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 9d1cd9a6ef..633c51ca48 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,3 +1,3 @@ -"shared/services/project-lookup.service" | papi-dts

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

    Index

    Variables

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_lookup_service_model_.html b/papi-dts/modules/_shared_services_project_lookup_service_model_.html index dec9a27caa..92241c5c19 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-lookup.service-model" | papi-dts

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

    Index

    Interfaces

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_settings_service_.html b/papi-dts/modules/_shared_services_project_settings_service_.html index de87c52b7d..30c1dccd47 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-settings.service" | papi-dts

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

    Index

    Variables

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_project_settings_service_model_.html b/papi-dts/modules/_shared_services_project_settings_service_model_.html index 6e5ba602e0..922eb5d4b0 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-settings.service-model" | papi-dts

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

    Index

    Interfaces

    IProjectSettingsService +"shared/services/project-settings.service-model" | papi-dts

    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 cc498ec0a8..3e6b846d34 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Variables

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_services_settings_service_model_.html b/papi-dts/modules/_shared_services_settings_service_model_.html index f2818c75c7..b7591a2357 100644 --- a/papi-dts/modules/_shared_services_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service-model" | papi-dts

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

    Index

    Type Aliases

    AllSettingsData +"shared/services/settings.service-model" | papi-dts

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

    Index

    Type Aliases

    Variables

    settingsServiceDataProviderName 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 d16c9ef062..e1c0533b0b 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 1294321532..9e50dfa665 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 f8dd146fa3..454cdc282e 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 cdb7ebcfc9..a0c6675c16 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 35c82d6b64..82ac84fb70 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 1e71fd0c6b..89d358458f 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 1dd8df75cf..60d4b7aecf 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 153ea36b74..b4dc70d524 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 e89c7704e3..bedb41a512 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 f57d0ec761..6ff6ae113e 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 b5079ea837..e950fbf798 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 facbf1d6c3..2df359090b 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 223520698b..a51b238a22 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 6dde94fe2c..5651fb72d7 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 8394c48b4a..a34075e031 100644 --- a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html +++ b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html @@ -2,4 +2,4 @@ returned from papi.dataProviders.registerEngine - only the one who registers a data provider engine is allowed to dispose of the data provider.

    Automatically includes all extensions' data providers that are added to DataProviders.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index 709849d0a7..c8305afaef 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html @@ -29,4 +29,4 @@

    Returns

    Unsubscriber to stop listening for updates

  • callback: ((value) => void)

    Function to run with the updated project setting value

  • options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html b/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html index b17ce3fa51..d6f352fdf5 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html +++ b/papi-dts/types/_papi_shared_types_.IProjectStorageInterpreter.html @@ -73,4 +73,4 @@

    Returns

    Unsubscriber to stop listening for updates

  • callback: ((value) => void)

    Function to run with the updated project setting value

  • options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 1ea3b4a680..dab9d93524 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 7dac759e5a..ee1ec106a6 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 d95bd5b91f..b9c36812e2 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectDataTypes.html @@ -6,4 +6,4 @@ provider data types.

    Example

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index 8447996f73..0472277015 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html +++ b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html @@ -3,4 +3,4 @@ ProjectSettingTypes.

    Example

    'platform.fullName'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html index e9d3370d9e..d80c5bd60e 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageDataTypes.html @@ -7,4 +7,4 @@ Interpreters.

    Example

    ProjectStorageDataTypes['MyExtensionProjectTypeName'] => MandatoryProjectStorageDataTypes & {
    ProjectData: DataProviderDataType<
    { projectId: string; section: number },
    string | undefined,
    string
    >;
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html index 688156cff9..092f2ffbe7 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageProjectTypes.html @@ -8,4 +8,4 @@ make PSIs available to support the PDPs available.

    Example

    'platform.notesOnly'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html b/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html index 82b5b2fc1e..e37c29d089 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html +++ b/papi-dts/types/_papi_shared_types_.ProjectStorageSettingDataScope.html @@ -3,4 +3,4 @@ PSI and adds the projectId.

    Type Parameters

    Type declaration

    • key: ProjectSettingName

      Key of the Project Setting to select

    • projectId: string

      ID for the project whose extension data to get

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectTypes.html b/papi-dts/types/_papi_shared_types_.ProjectTypes.html index 906f2a6bad..c8ca090ef4 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectTypes.html @@ -7,4 +7,4 @@ make PSIs available to support the PDPs available.

    Example

    'platform.notesOnly'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 0603e8be42..19643d5a1c 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -2,4 +2,4 @@

    Automatically includes all extensions' user settings that are added to SettingTypes.

    Example

    'platform.verseRef'
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index 4515b04fa1..62ba68789b 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html index 19878f3498..7023d85faf 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -34,4 +34,4 @@

    See

    Returns Promise<DataProviderUpdateInstructions<TProjectDataTypes & MandatoryProjectDataTypes>>

    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/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html index 3c12040d02..a545142a84 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 89ad7ae44d..6da1bcadf1 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 e36e295216..86875b9429 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 4570dfc80d..4b12bf971e 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 958621cd86..6c15a38292 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html @@ -1,2 +1,2 @@ DialogTabTypes | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html index 74476927d6..d6c377c73f 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html @@ -1 +1 @@ -ProjectDialogOptionsBase | papi-dts

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index e2a875fccf..68d74d33bc 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html @@ -1,3 +1,3 @@ SelectMultipleProjectsDialogOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html index 485523dbe3..575cb05570 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html @@ -1,2 +1,2 @@ SelectProjectDialogOptions | papi-dts

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html index b241c10da3..ba2f6ce56e 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 bd535b576b..20118b34b4 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 db89ae7705..d5deb21fe8 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 e69e5b8593..dc753e17ec 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 f7ab5a41d5..3666c5e9f3 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 a2e39a3cc3..f6e07bd068 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 8958e6edd5..069e0c55dd 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 52d379b78e..e54b84fdd1 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 5d2ad51949..8803fd5d90 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 b522a9f9ae..d7c922b454 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 22d700ef28..cbecb25aa7 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 5bc52d3015..591c3d2e53 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 3f629a7c8e..7f022017f1 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 90c631244a..1fd4cdf302 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 e56b01bf64..6dd32014ba 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 2dd72cc0a4..be0e8d8185 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 580017938e..cfbd328922 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 de70ab2d90..9c6bbef5c4 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 5fa270d978..9740015449 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 14b2882c36..d71251d933 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 1c0bd2a51a..cd4c894ba0 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html @@ -20,4 +20,4 @@

    @see DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Type Parameters

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html index e83beec2e9..83c7fe61d5 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html @@ -27,4 +27,4 @@
  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html index 7fcaa42e55..5f9b7e431c 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html @@ -23,4 +23,4 @@

    OR

    class MyDPE implements IDataProviderEngine<MyDataTypes> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<MyDataTypes>) {}
    ...
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html index 7cf08126b2..b2ba246dd5 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html @@ -2,4 +2,4 @@ data provider (only the service that set it up should dispose of it) with dataProviderService.registerEngine

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_interface_.default.html b/papi-dts/types/_shared_models_data_provider_interface_.default.html index 241020a80d..31636b7d9b 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.default.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.default.html @@ -3,4 +3,4 @@ getting a data provider with papi.dataProviders.get.

    Note: each set<data_type> method has a corresponding get<data_type> and subscribe<data_type> method.

    -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html index a8e5bdd8b0..8d43f8c2ec 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 345b714324..5f5d51ccbd 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 856d4db9de..891ffb816f 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 4e54e3c834..695e2946ba 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 31fb39d3f8..67a157ae28 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 9068a689ad..d890d8bd6e 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 8c6ce5bc33..31bf1c0368 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 0615ec99cd..aaf7a86d38 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 1bf94ac924..db21713aec 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 8ec3a6db03..8360518ead 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 9b106043a0..a38687b0c7 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 3e30d979bb..d3951aa7f9 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 4c9273365b..68519c3a0d 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 6815c6e687..eb138dfb09 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

    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 76a96133a9..ac5885e567 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.AddWebViewEvent.html @@ -1,2 +1,2 @@ AddWebViewEvent | papi-dts
    AddWebViewEvent: {
        layout: Layout;
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are created

    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index f445fbafcc..0e525cfe67 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 c1bf1ff60c..813f0a66bf 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html @@ -1,2 +1,2 @@ FloatSize | papi-dts
    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -

    Type declaration

    • height: number
    • width: number

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html index 558822e7ee..1317c974a5 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html @@ -1,2 +1,2 @@ Layout | papi-dts

    Information about how a Paranext tab fits into the dock layout

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html index 63969d70d6..353aa9793e 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html @@ -1,2 +1,2 @@ OnLayoutChangeRCDock | papi-dts
    OnLayoutChangeRCDock: ((newLayout, currentTabId?, direction?) => Promise<void>)

    Rc-dock's onLayoutChange prop made asynchronous - resolves

    -

    Type declaration

      • (newLayout, currentTabId?, direction?): Promise<void>
      • Parameters

        • newLayout: LayoutBase
        • Optional currentTabId: string
        • Optional direction: DropDirection

        Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html index 3bba77c7e1..7b78a21506 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html @@ -1 +1 @@ -PanelDirection | papi-dts
    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Generated using TypeDoc

    \ No newline at end of file +PanelDirection | papi-dts
    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html index 6b30b81355..5330f1bfef 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 a8f2de63fd..ae44366b9a 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 84c1329368..831319a937 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 b020125f01..65df274951 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html @@ -1,4 +1,4 @@ TabLoader | papi-dts
    TabLoader: ((savedTabInfo) => TabInfo)

    Function that takes a SavedTabInfo and creates a Paranext tab out of it. Each type of tab must provide a TabLoader.

    For now all tab creators must do their own data type verification

    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html index 42ed0f31b1..8d7aafaefe 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 ae5afc766d..54d3ed08e3 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html @@ -1,2 +1,2 @@ WebViewTabProps | papi-dts
    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index cdb3b80b6a..f5c37c70db 100644 --- a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html +++ b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html @@ -3,4 +3,4 @@

    Works with generic types IDataProvider, DataProviderInternal, IDisposableDataProvider, and IDataProviderEngine along with the papi-shared-types extensible interfaces DataProviders and DisposableDataProviders

    -

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html index b67bf289fd..2ee05733e1 100644 --- a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html @@ -1,3 +1,3 @@ DisposableNetworkObject | papi-dts
    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

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

    Type Parameters

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html index bc3c494379..9c3911e774 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 8dfb12b87b..adfdd06201 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 3a69d5feb3..710c2cff1c 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 645dcb153f..5034aa93ac 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html @@ -1,3 +1,3 @@ NetworkableObject | papi-dts
    NetworkableObject<T>: T & CannotHaveOnDidDispose

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

    Type Parameters

    • T = object

    See

    networkObjectService

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html index 2cf169be7d..755abb6681 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html @@ -27,4 +27,4 @@

    OR

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html index d6d722bc38..8893e49fd7 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngineTypes.html @@ -1,2 +1,2 @@ ProjectDataProviderEngineTypes | papi-dts
    ProjectDataProviderEngineTypes: {
        [ProjectType in ProjectTypes]: IProjectDataProviderEngine<ProjectType>
    }

    All possible types for ProjectDataProviderEngines: IProjectDataProviderEngine

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html index 6c5e3c7ddf..be6d7c52cf 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html @@ -9,4 +9,4 @@

    This is the smallest level of granularity provided by a PDP for accessing extension data. There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • extensionName: string

    Name of an extension as provided in its manifest

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html index 87d9a3f1c6..a88a753a80 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html @@ -32,4 +32,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html index 90682c35b8..83bff569a6 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html @@ -7,11 +7,11 @@ to this Project Data Provider

    Returns Promise<undefined | string>

    Extension project data in this project for an extension to use in serving its extension project data

    -
  • setExtensionData:function
  • setExtensionData:function
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html index 30ff77c8fe..98715dcf3b 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -5,4 +5,4 @@
  • projectType: ProjectTypes

    Indicates what sort of project this is which implies its data shape (e.g., what data streams should be available)

  • storageType: string

    Indicates how the project is persisted to storage

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html index f7c1502d71..90bb33baec 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.DefaultProjectStorageDataTypes.html @@ -20,4 +20,4 @@
  • This is an easy pattern to follow when starting to learn how to make new projectTypes in Platform.Bible.
  • -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html index 6b5ab87b4e..b40aa736fc 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.MandatoryProjectStorageDataTypes.html @@ -48,4 +48,4 @@ so following this interface ensures your PSI will not break if such a requirement is implemented. -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html index a9b483fefd..8dc9191053 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageExtensionDataScope.html @@ -1,4 +1,4 @@ ProjectStorageExtensionDataScope | papi-dts
    ProjectStorageExtensionDataScope: ExtensionDataScope & {
        projectId: string;
    }

    Indicates to a PSI what extension data is being referenced on what project. Generally, a PDP passes calls to ExtensionData data type methods to its PSI and adds the projectId.

    Type declaration

    • projectId: string

      ID for the project whose extension data to get

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html index 60984c9028..53442872ad 100644 --- a/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html +++ b/papi-dts/types/_shared_models_project_storage_interpreter_model_.ProjectStorageProjectDataScope.html @@ -10,4 +10,4 @@ There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • projectId: string

    ID for the project whose raw data chunk to get

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html index 63c8a6a97d..088dbe8481 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewDefinitionUpdatableProperties.html @@ -1,4 +1,4 @@ GetWebViewDefinitionUpdatableProperties | papi-dts
    GetWebViewDefinitionUpdatableProperties: (() => WebViewDefinitionUpdatableProperties | undefined)

    Gets the updatable properties on this WebView's WebView definition

    @returns updatable properties this WebView's WebView definition or undefined if not found for some reason

    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html index 116e8c4489..f8045d1a6d 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 387461d7d1..b8f53c2f11 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 e8bc64a2e3..0888112a8e 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 a7c135c564..a4fdd11ad2 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -24,4 +24,4 @@

    @example

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

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html index 6ea71a02bb..fa7a155503 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html @@ -1,2 +1,2 @@ WebViewDefinition | papi-dts

    Properties defining a type of WebView created by extensions to show web content

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html index 04fbc1408d..39a56bdc84 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 e1fed83037..b7aaf08696 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html @@ -1,3 +1,3 @@ WebViewDefinitionHtml | papi-dts
    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html index 077b7367b7..7ab09986f3 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html @@ -1,4 +1,4 @@ WebViewDefinitionReact | papi-dts
    WebViewDefinitionReact: WebViewDefinitionBase & {
        contentType?: React;
        styles?: string;
    }

    WebView representation using React

    Type declaration

    • Optional contentType?: React

      Indicates this WebView uses React

    • Optional styles?: string

      String of styles to be loaded into the iframe for this WebView

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html index 1a38f99498..84f97a8a57 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html @@ -1,4 +1,4 @@ WebViewDefinitionURL | papi-dts
    WebViewDefinitionURL: WebViewDefinitionBase & {
        contentType: URL;
    }

    WebView representation using a URL.

    Note: you can only use papi-extension: and https: urls

    Type declaration

    • contentType: URL

      Indicates this WebView uses a URL

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html index cfe7ae7283..3fb515cb76 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html @@ -1,2 +1,2 @@ WebViewDefinitionUpdatableProperties | papi-dts
    WebViewDefinitionUpdatableProperties: Pick<WebViewDefinitionBase, "iconUrl" | "title" | "tooltip">

    The properties on a WebViewDefinition that may be updated when that webview is already displayed

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html index 3a6ab9aa0c..55b39d91b9 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html @@ -1,3 +1,3 @@ WebViewDefinitionUpdateInfo | papi-dts
    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html index ba2e791d89..45b935789b 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html @@ -1,2 +1,2 @@ WebViewId | papi-dts
    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html index 9d9b60cbc9..5cf9f5d2bd 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 13cf49ad49..c6f9ad5c79 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html @@ -1,2 +1,2 @@ WebViewType | papi-dts
    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index ee3915d8be..41072fdf8d 100644 --- a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html +++ b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html @@ -1,4 +1,4 @@ moduleSummaryComments | papi-dts
    moduleSummaryComments: {}

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -

    Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html index c559f8656e..4d9fac80c0 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

      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 c1a4ddfe42..f7b34d875b 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html @@ -1 +1 @@ -MenuDataDataTypes | papi-dts
      MenuDataDataTypes: {
          MainMenu: DataProviderDataType<undefined, MultiColumnMenu, never>;
          WebViewMenu: DataProviderDataType<ReferencedItem, WebViewMenu, never>;
      }

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +MenuDataDataTypes | papi-dts
      MenuDataDataTypes: {
          MainMenu: DataProviderDataType<undefined, MultiColumnMenu, never>;
          WebViewMenu: DataProviderDataType<ReferencedItem, WebViewMenu, never>;
      }

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html index 2e71833b7c..d8e17e58fc 100644 --- a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html @@ -2,4 +2,4 @@ the spread of the contents array of the request as its parameters. The function should return an object that becomes the contents object of the response. This type of handler is a normal function.

      -

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html index ffe8082244..ef30fdbb4d 100644 --- a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html @@ -2,4 +2,4 @@ accept a ComplexRequest object as its single parameter. The function should return a ComplexResponse object that becomes the response.. This type of handler is the most flexible of the request handlers.

      -

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html index 8ef319cc59..6163ce4202 100644 --- a/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ContentsRequestHandler.html @@ -1,4 +1,4 @@ ContentsRequestHandler | papi-dts

      Type alias ContentsRequestHandler<TParam, TReturn>

      ContentsRequestHandler<TParam, TReturn>: ((contents) => Promise<TReturn>)

      Contents handler function for a request. Called when a request is handled. The function should accept the contents object of the request as its single parameter. The function should return an object that becomes the contents object of the response.

      -

      Type Parameters

      • TParam = any

      • TReturn = any

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html index 39e3a15a92..fcb4123d9e 100644 --- a/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_services_project_lookup_service_model_.ProjectMetadataFilterOptions.html @@ -12,4 +12,4 @@ function) to determine if they should be included.

      Defaults to all ProjectTypes, so all projects that do not match excludeProjectTypes will be included

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html index 1ca48d08c3..0292538d90 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html @@ -1,4 +1,4 @@ SimultaneousProjectSettingsChanges | papi-dts
      SimultaneousProjectSettingsChanges: {
          [ProjectSettingName in ProjectSettingNames]?: {
              currentValue: ProjectSettingTypes[ProjectSettingName];
              newValue: ProjectSettingTypes[ProjectSettingName];
          }
      }

      All project settings changes being set in one batch

      Project settings may be circularly dependent on one another, so multiple project settings may need to be changed at once in some cases

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html index 29a5932f2f..620bec6721 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html @@ -1 +1 @@ -AllSettingsData | papi-dts
      AllSettingsData: {
          [SettingName in SettingNames]: SettingTypes[SettingName]
      }

      Generated using TypeDoc

      \ No newline at end of file +AllSettingsData | papi-dts
      AllSettingsData: {
          [SettingName in SettingNames]: SettingTypes[SettingName]
      }

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html index b87c84e0b9..5590c3eaa7 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html +++ b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html @@ -3,19 +3,19 @@

      Returns Promise<SettingTypes[SettingName]>

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

      Throws

      If no default value is available for the setting.

      -
    • reset:function
    • reset:function
    • set:function
    • set:function
    • subscribe:function
    • subscribe:function
    • Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html index 638fbf8da4..41d765e0f2 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html @@ -9,4 +9,4 @@

      The closest possible representation of the unnamed (````) data type follows:

      '': DataProviderDataType<SettingName, SettingTypes[SettingName], SettingTypes[SettingName]>;
       
      -

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexRequest.html b/papi-dts/types/_shared_utils_util_.ComplexRequest.html index c5d68f8e42..a4004e935c 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexRequest.html +++ b/papi-dts/types/_shared_utils_util_.ComplexRequest.html @@ -1,4 +1,4 @@ ComplexRequest | papi-dts

      Type alias ComplexRequest<TParam>

      ComplexRequest<TParam>: {
          contents: TParam;
          senderId: number;
      }

      Type of object passed to a complex request handler that provides information about the request. This type is used as the public-facing interface for requests

      Type Parameters

      • TParam = unknown

      Type declaration

      • contents: TParam
      • senderId: number

        The one who sent the request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponse.html b/papi-dts/types/_shared_utils_util_.ComplexResponse.html index a3bc198338..b73930ee90 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponse.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponse.html @@ -1,4 +1,4 @@ ComplexResponse | papi-dts

      Type alias ComplexResponse<TReturn>

      Type of object to create when handling a complex request where you desire to provide additional information beyond the contents of the response This type is used as the public-facing interface for responses

      -

      Type Parameters

      • TReturn = unknown

      Generated using TypeDoc

      \ No newline at end of file +

      Type Parameters

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html index 001659ce93..8fb0471571 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponseFailure.html @@ -1,3 +1,3 @@ ComplexResponseFailure | papi-dts

      Type alias ComplexResponseFailure

      ComplexResponseFailure: {
          errorMessage: string;
          success: false;
      }

      Type declaration

      • errorMessage: string

        Error explaining the problem that is only populated if success is false

      • success: false

        Whether the handler that created this response was successful in handling the request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html index 02054fedb5..fca08c02a7 100644 --- a/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html +++ b/papi-dts/types/_shared_utils_util_.ComplexResponseSuccess.html @@ -1,4 +1,4 @@ ComplexResponseSuccess | papi-dts

      Type alias ComplexResponseSuccess<TReturn>

      ComplexResponseSuccess<TReturn>: {
          contents: TReturn;
          success: true;
      }

      Type Parameters

      • TReturn = unknown

      Type declaration

      • contents: TReturn

        Content with which to respond to the request. Must be provided unless the response failed or TReturn is undefined

      • success: true

        Whether the handler that created this response was successful in handling the request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index 5a8fcf51b4..5508015fe2 100644 --- a/papi-dts/types/_shared_utils_util_.RequestType.html +++ b/papi-dts/types/_shared_utils_util_.RequestType.html @@ -1,4 +1,4 @@ RequestType | papi-dts
      RequestType: {
          category: string;
          directive: string;
      }

      Information about a request that tells us what to do with it

      Type declaration

      • category: string

        The general category of request

      • directive: string

        Specific identifier for this type of request

        -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index 33b1879c19..fe5043ad35 100644 --- a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html +++ b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html @@ -1,3 +1,3 @@ SerializedRequestType | papi-dts

      Type alias SerializedRequestType

      SerializedRequestType: `${string}${typeof REQUEST_TYPE_SEPARATOR}${string}`

      String version of a request type that tells us what to do with a request.

      Consists of two strings concatenated by a colon

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index d0dac0ca66..595cc2deb4 100644 --- a/papi-dts/variables/__papi_backend_.DataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.DataProviderEngine.html @@ -2,4 +2,4 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

      See

      IDataProviderEngine for more information on extending this class.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html index 064830ce7c..6a98acb98e 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -8,4 +8,4 @@ If a Project Data Provider Engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

      See

      IProjectDataProviderEngine for more information on extending this class.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index f98eb667ea..48ff3e243c 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

      Variable commandsConst

      The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index 5efd14f0f7..456a7616d2 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

      Variable dataProvidersConst

      dataProviders: DataProviderService

      Service that allows extensions to send and receive data to/from other extensions

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index f17b9090f8..81d557d301 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -33,4 +33,4 @@
    • webViews: WebViewServiceType

      Service exposing various functions related to using webViews

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

      -
    • Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index 213676d50b..ec114bd6e1 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

      Variable dialogsConst

      dialogs: DialogService

      Prompt the user for responses with dialogs

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index fbbaa536c9..4c065ba221 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

      Variable internetConst

      internet: InternetService

      Service that provides a way to call fetch since the original function is not available

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index 229163121a..fc6f75db95 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

      Variable loggerConst

      logger: MainLogger & {
          default: MainLogger;
      }

      All extensions and services should use this logger to provide a unified output of logs

      -

      Type declaration

      • default: MainLogger

      Generated using TypeDoc

      \ No newline at end of file +

      Type declaration

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index 69d0a3a618..dce57582b6 100644 --- a/papi-dts/variables/__papi_backend_.menuData.html +++ b/papi-dts/variables/__papi_backend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

      Variable menuDataConst

      Service that allows to get and store menu data

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index c6d3f188a6..6a0bfbebe3 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

      Variable networkConst

      Service that provides a way to send and receive network events

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index f256a787ce..dcc970d3be 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

      Variable projectDataProvidersConst

      Service that registers and gets project data providers

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index 939e22b0ec..6b5309bb31 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

      Variable projectLookupConst

      Provides metadata for projects known by the platform

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.projectSettings.html b/papi-dts/variables/__papi_backend_.projectSettings.html index ac38bf1e19..a08af57f0d 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,3 +1,3 @@ projectSettings | papi-dts

      Variable projectSettingsConst

      projectSettings: IProjectSettingsService

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

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 394a80e06f..bf5165641d 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

      Variable storageConst

      This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index 2f8a154fa2..9d1b1bda1e 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,2 +1,2 @@ webViewProviders | papi-dts

      Variable webViewProvidersConst

      webViewProviders: PapiWebViewProviderService

      Interface for registering webView providers

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 2a5bf387ab..cb1cef1fda 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

      Variable webViewsConst

      Service exposing various functions related to using webViews

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

      -

      Generated using TypeDoc

      \ No newline at end of file +

      Generated using TypeDoc

      \ No newline at end of file diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 8fa3c9523e..d617865a9d 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

      Variable defaultConst

      default: {}

      Exporting empty object so people don't have to put 'type' in their import statements

      -

      Type declaration

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index ce80d88e3f..a1421b32ce 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 c089f077b6..7fd7d6c596 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 adba2ec206..11d3acddb4 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

        Variable commandsConst

        The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index a433cf10c8..57cc26acd8 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

        Variable dataProvidersConst

        dataProviders: DataProviderService

        Service that allows extensions to send and receive data to/from other extensions

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index fb0e1f3c88..a04f98480b 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -22,4 +22,4 @@
      • settings: ISettingsService
      • webViews: WebViewServiceType

        Service exposing various functions related to using webViews

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

        -
      • Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index b670ea687b..cb4348b108 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

        Variable dialogsConst

        dialogs: DialogService

        Prompt the user for responses with dialogs

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index 10dcc17162..74a27b47ae 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

        Variable internetConst

        internet: InternetService

        Service that provides a way to call fetch since the original function is not available

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index acebeaf029..bd1037cd68 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

        Variable loggerConst

        logger: MainLogger & {
            default: MainLogger;
        }

        All extensions and services should use this logger to provide a unified output of logs

        -

        Type declaration

        • default: MainLogger

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index 8c49757d86..b09ea11aca 100644 --- a/papi-dts/variables/__papi_frontend_.menuData.html +++ b/papi-dts/variables/__papi_frontend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

        Variable menuDataConst

        Service that allows to get and store menu data

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index 749d1f5815..20d753380b 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

        Variable networkConst

        Service that provides a way to send and receive network events

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 3a9ff1b901..e48b88b66c 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

        Variable projectDataProvidersConst

        Service that registers and gets project data providers

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index 42fe912c7c..86fa049daf 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -1,2 +1,2 @@ projectLookup | papi-dts

        Variable projectLookupConst

        Provides metadata for projects known by the platform

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 025440d570..58eb4adcdb 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

        Variable reactConst

        React hooks that enable interacting with the papi in React components more easily.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index ae11a8c08c..bb4e0f6a0e 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index 05092ace45..dcb9f22e96 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

        Variable webViewsConst

        Service exposing various functions related to using webViews

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

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html index e5bee7768a..baccd07c97 100644 --- a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html +++ b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html @@ -1,4 +1,4 @@ default | papi-dts

        This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_services_execution_token_service_.default.html b/papi-dts/variables/_node_services_execution_token_service_.default.html index 5c6b3d2a69..28952134ae 100644 --- a/papi-dts/variables/_node_services_execution_token_service_.default.html +++ b/papi-dts/variables/_node_services_execution_token_service_.default.html @@ -1 +1 @@ -default | papi-dts
        default: {
            registerExtension: typeof registerExtension;
            tokenIsValid: typeof tokenIsValid;
            unregisterExtension: typeof unregisterExtension;
        }

        Type declaration

        • registerExtension: typeof registerExtension
        • tokenIsValid: typeof tokenIsValid
        • unregisterExtension: typeof unregisterExtension

        Generated using TypeDoc

        \ No newline at end of file +default | papi-dts
        default: {
            registerExtension: typeof registerExtension;
            tokenIsValid: typeof tokenIsValid;
            unregisterExtension: typeof unregisterExtension;
        }

        Type declaration

        • registerExtension: typeof registerExtension
        • tokenIsValid: typeof tokenIsValid
        • unregisterExtension: typeof unregisterExtension

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index 390736b6aa..5f9565061e 100644 --- a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html @@ -1 +1 @@ -FILE_PROTOCOL | papi-dts

        Variable FILE_PROTOCOLConst

        FILE_PROTOCOL: "file://" = 'file://'

        Generated using TypeDoc

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

        Variable FILE_PROTOCOLConst

        FILE_PROTOCOL: "file://" = 'file://'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index 685dea3f58..5ce32dff2c 100644 --- a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html @@ -1 +1 @@ -RESOURCES_PROTOCOL | papi-dts

        Variable RESOURCES_PROTOCOLConst

        RESOURCES_PROTOCOL: "resources://" = 'resources://'

        Generated using TypeDoc

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

        Variable RESOURCES_PROTOCOLConst

        RESOURCES_PROTOCOL: "resources://" = 'resources://'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html index d6049b8045..7732c582f1 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 2ee499c137..ad09efa5e9 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE | papi-dts
        SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE: "platform.selectMultipleProjects" = 'platform.selectMultipleProjects'

        The tabType for the select multiple projects dialog in select-multiple-projects.dialog.tsx

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html index 3611c1be3a..07e072575c 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_PROJECT_DIALOG_TYPE | papi-dts
        SELECT_PROJECT_DIALOG_TYPE: "platform.selectProject" = 'platform.selectProject'

        The tabType for the select project dialog in select-project.dialog.tsx

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html index 1f1aad951e..4180984458 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CATEGORY_COMMAND.html @@ -1,2 +1,2 @@ CATEGORY_COMMAND | papi-dts
        CATEGORY_COMMAND: "command" = 'command'

        Prefix on requests that indicates that the request is a command

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html index 69515690cd..ba60723eb1 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_SERVER.html @@ -1,2 +1,2 @@ CLIENT_ID_SERVER | papi-dts
        CLIENT_ID_SERVER: 0 = 0

        "Client id" for the server

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html index 2d8af9c30f..6ce87235e2 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNASSIGNED.html @@ -1,2 +1,2 @@ CLIENT_ID_UNASSIGNED | papi-dts
        CLIENT_ID_UNASSIGNED: -1 = -1

        Represents when the client id has not been assigned by the server

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html index 9c0bf1bd01..2697bd6cac 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CONNECTOR_INFO_DISCONNECTED.html @@ -1,2 +1,2 @@ CONNECTOR_INFO_DISCONNECTED | papi-dts
        CONNECTOR_INFO_DISCONNECTED: Readonly<{
            clientId: -1;
        }>

        Represents when the connector info has not been populated by the server

        -

        Type declaration

        • clientId: -1

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html index f354285f21..3e49f48827 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_MAX.html @@ -1,2 +1,2 @@ WEBSOCKET_ATTEMPTS_MAX | papi-dts
        WEBSOCKET_ATTEMPTS_MAX: 5 = 5

        Number of attempts a client will make to connect to the WebSocket server before failing

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html index 7d4d0825c7..ecc806e44d 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_ATTEMPTS_WAIT.html @@ -1,3 +1,3 @@ WEBSOCKET_ATTEMPTS_WAIT | papi-dts
        WEBSOCKET_ATTEMPTS_WAIT: 1000 = 1000

        Time in ms for the client to wait before attempting to connect to the WebSocket server again after a failure

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html index 90566e3100..b2634e6d7b 100644 --- a/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html +++ b/papi-dts/variables/_shared_data_network_connector_model_.WEBSOCKET_PORT.html @@ -1,2 +1,2 @@ WEBSOCKET_PORT | papi-dts
        WEBSOCKET_PORT: 8876 = 8876

        Port to use for the webSocket

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_data_provider_service_.default.html b/papi-dts/variables/_shared_services_data_provider_service_.default.html index a8901f3089..61552065d6 100644 --- a/papi-dts/variables/_shared_services_data_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_data_provider_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

        Service that allows extensions to send and receive data to/from other extensions

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 25d690e8f2..a515b10e10 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 1f69ec2920..1acc8ddd79 100644 --- a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html +++ b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html @@ -1,2 +1,2 @@ CATEGORY_DIALOG | papi-dts
        CATEGORY_DIALOG: "dialog" = 'dialog'

        Prefix on requests that indicates that the request is related to dialog operations

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index a34d087ce5..035bcb70b3 100644 --- a/papi-dts/variables/_shared_services_internet_service_.default.html +++ b/papi-dts/variables/_shared_services_internet_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

        Service that provides a way to call fetch since the original function is not available

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html index 8e6b44eba9..f22c88cc38 100644 --- a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html +++ b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html @@ -1 +1 @@ -WARN_TAG | papi-dts
        WARN_TAG: "<WARN>" = '<WARN>'

        Generated using TypeDoc

        \ No newline at end of file +WARN_TAG | papi-dts
        WARN_TAG: "<WARN>" = '<WARN>'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index 9eddfd57a1..ad1621ad1e 100644 --- a/papi-dts/variables/_shared_services_logger_service_.default.html +++ b/papi-dts/variables/_shared_services_logger_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts
        default: log.MainLogger & {
            default: log.MainLogger;
        }

        All extensions and services should use this logger to provide a unified output of logs

        -

        Type declaration

        • default: log.MainLogger

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_.default.html b/papi-dts/variables/_shared_services_menu_data_service_.default.html index 28cb6c5bbc..7f2ffe78bc 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 7b6747ffcb..88dcce2150 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html @@ -1,3 +1,3 @@ menuDataServiceObjectToProxy | papi-dts
        menuDataServiceObjectToProxy: Readonly<{
            dataProviderName: "platform.menuDataServiceDataProvider";
        }>

        Type declaration

        • dataProviderName: "platform.menuDataServiceDataProvider"

          This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html index fa7c86a4e9..50da3bed22 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html @@ -1,3 +1,3 @@ menuDataServiceProviderName | papi-dts
        menuDataServiceProviderName: "platform.menuDataServiceDataProvider" = 'platform.menuDataServiceDataProvider'

        This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_object_service_.default.html b/papi-dts/variables/_shared_services_network_object_service_.default.html index 140fb77667..7ccca9f7b9 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 1d5ca21254..961394e942 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 23d16bb4d3..fc66d9fc51 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts
        networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

        Generated using TypeDoc

        \ No newline at end of file +networkObjectStatusServiceNetworkObjectName | papi-dts
        networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index 24d39f0022..153a67136a 100644 --- a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html +++ b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html @@ -1,2 +1,2 @@ papiNetworkService | papi-dts
        papiNetworkService: PapiNetworkService

        Service that provides a way to send and receive network events

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html index 3e7c3bad11..8e80e368c2 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiBackendProjectDataProviderService | papi-dts
        papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

        Service that registers and gets project data providers

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html index 5b13e70321..aa80c11b78 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiFrontendProjectDataProviderService | papi-dts
        papiFrontendProjectDataProviderService: {
            get: typeof get;
        }

        Service that gets project data providers

        -

        Type declaration

        • get: typeof get

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_lookup_service_.default.html b/papi-dts/variables/_shared_services_project_lookup_service_.default.html index b64bf41339..61c1a7b717 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 28c1bc828f..e618ef53d4 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_model_.projectLookupServiceNetworkObjectName.html @@ -1 +1 @@ -projectLookupServiceNetworkObjectName | papi-dts
        projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

        Generated using TypeDoc

        \ No newline at end of file +projectLookupServiceNetworkObjectName | papi-dts
        projectLookupServiceNetworkObjectName: "ProjectLookupService" = 'ProjectLookupService'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_.default.html b/papi-dts/variables/_shared_services_project_settings_service_.default.html index 241ed5df22..6cc4fbd674 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_project_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html index ab368f9dad..3112156f90 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html @@ -1 +1 @@ -projectSettingsServiceNetworkObjectName | papi-dts
        projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

        Generated using TypeDoc

        \ No newline at end of file +projectSettingsServiceNetworkObjectName | papi-dts
        projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index 87370af749..661b7ec534 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts

        Generated using TypeDoc

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

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html index ad5a687b99..38d003c5cb 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html @@ -1,3 +1,3 @@ settingsServiceDataProviderName | papi-dts
        settingsServiceDataProviderName: "platform.settingsServiceDataProvider" = 'platform.settingsServiceDataProvider'

        This name is used to register the settings service data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html index 9380987037..1545dc7de9 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html @@ -1,3 +1,3 @@ settingsServiceObjectToProxy | papi-dts
        settingsServiceObjectToProxy: Readonly<{
            dataProviderName: "platform.settingsServiceDataProvider";
        }>

        Type declaration

        • dataProviderName: "platform.settingsServiceDataProvider"

          This name is used to register the settings service data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

          -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html index a70c190fe9..55a92bea27 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 51d0c5b312..8f00705f88 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html @@ -1,2 +1,2 @@ papiWebViewProviderService | papi-dts
        papiWebViewProviderService: PapiWebViewProviderService

        Interface for registering webView providers

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_.default.html b/papi-dts/variables/_shared_services_web_view_service_.default.html index 5e5de85535..054509bcfe 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 a49898554c..7afb675e23 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_ADD_WEB_VIEW | papi-dts
        EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

        Name to use when creating a network event that is fired when webViews are created

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html index 1b1874e6cf..888fe128ba 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
        NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

        Generated using TypeDoc

        \ No newline at end of file +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
        NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html index bade0b92d5..a28603cc3f 100644 --- a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html +++ b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html @@ -1,3 +1,3 @@ MODULE_SIMILAR_APIS | papi-dts

        Variable MODULE_SIMILAR_APISConst

        MODULE_SIMILAR_APIS: Readonly<{
            [moduleName: string]: string | {
                [process in ProcessType | "default"]?: string
            } | undefined;
        }>

        Modules that someone might try to require in their extensions that we have similar apis for. When an extension requires these modules, an error throws that lets them know about our similar api.

        -

        Type declaration

        • [moduleName: string]: string | {
              [process in ProcessType | "default"]?: string
          } | undefined

        Generated using TypeDoc

        \ No newline at end of file +

        Type declaration

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html index 1c7c8765c0..176cf845d7 100644 --- a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html +++ b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html @@ -1,2 +1,2 @@ REQUEST_TYPE_SEPARATOR | papi-dts

        Variable REQUEST_TYPE_SEPARATORConst

        REQUEST_TYPE_SEPARATOR: ":" = ':'

        Separator between parts of a serialized request

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index e2f9779357..de4e7f6c61 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

        Variable isPackaged

        isPackaged: boolean

        Whether this process is packaged or running from sources

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index e023f18765..4fed455715 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

        Variable logLevel

        logLevel: LogLevel

        How much logging should be recorded. Defaults to 'debug' if not packaged, 'info' if packaged

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index a5c7a8c3e8..2079c79783 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

        Variable processType

        processType: ProcessType

        Type of process this is. Helps with running specific code based on which process you're in

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index fbb1a87596..fdb925075e 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

        Variable resourcesPath

        resourcesPath: string

        Path to the app's resources directory. This is a string representation of the resources uri on frontend

        -

        Generated using TypeDoc

        \ No newline at end of file +

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/enums/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index 45d33a3660..0d98362043 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 ae40fdfcfd..78daa07cfa 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 3d9ae5102c..3af780b75c 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

        Function ChapterRangeSelector

        Generated using TypeDoc

        \ No newline at end of file +ChapterRangeSelector | platform-bible-react

        Function ChapterRangeSelector

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index 077b1e58f4..bf9569aebe 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 1c703bb765..d394dae714 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 d025f74ce7..4e9fd4c7b8 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 e03385ebda..15d5ef9b36 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 26a93e27ec..700719909d 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 177fdb2d5c..66adf0e078 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 80666144f5..84f55d51eb 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 944cf16d41..49f4c82a88 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 9d84076766..7e7c50a54d 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 787955d0b5..bc9a289df3 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 b63d1f1413..1794936c3e 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ Table | platform-bible-react

        Generated using TypeDoc

        \ No newline at end of file +

        Type Parameters

        Parameters

        Returns Element

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index 3b702c7da7..54981da8bb 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 a11065fdb2..17f1208817 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 a02b8f5e9c..84d0a59438 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 8a55f7e0d4..1a8bc51640 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 3fadc80ee5..c46749b91f 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 ebb56f1ab1..2e8d0b7e63 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 95d49b5f44..c9ae36f5d4 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 82022aa0e9..1c362a5a70 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 c27448ae49..b88c361565 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 47a6febd82..aaa80e1247 100644 --- a/platform-bible-react/types/AnchorOrigin.html +++ b/platform-bible-react/types/AnchorOrigin.html @@ -1 +1 @@ -AnchorOrigin | platform-bible-react

        Type alias AnchorOrigin

        AnchorOrigin: SnackbarOrigin

        Generated using TypeDoc

        \ No newline at end of file +AnchorOrigin | platform-bible-react

        Type alias AnchorOrigin

        AnchorOrigin: SnackbarOrigin

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-react/types/ButtonProps.html b/platform-bible-react/types/ButtonProps.html index e0e1531a18..97a4800ea8 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 f1915556d8..9f9d7200c8 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 d08ba8c484..bfe05b8fc3 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 4b966587ae..e376d818d2 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 fe521bc025..98f2675373 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 e4f7e318d1..af113f9d76 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 248aad1062..56b857612e 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 6b8fba5842..50028cd5a8 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 62b13fd4b5..dc4694e987 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 d47a9b1967..30427750b5 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 c75ca0c3b2..cb31c86191 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 d26e334705..df99aea8e3 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 dcfe756e46..09ea26c471 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 dbc1050a96..f224b948bc 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 26b1eb4bfd..03e4f1e239 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 53ada704cb..c27dc36801 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 b5f5ec0579..fc447f2dd0 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 3af7785c16..f609677140 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 d5a538de5c..a43e44e389 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 5b4b9468e1..81c27d6988 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 ebbe9ad862..d22e8c8b4f 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 2f5e2dfa19..0ec98dddc3 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 6e34aeb236..251ec2582b 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 4a725595af..b96d716568 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 b79a1422f7..ae3b2d289e 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 bbaf0e4012..bfb08cbaff 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 9484bde152..9ff7645b33 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 b25d4e4654..4f2ac29c4c 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 2d7f7cfea8..0b08d6c3ba 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 2e279cf21a..bd17e5ad98 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 3f936327d1..0ce617ef07 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 204ebee631..dcbb042e01 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 95e02b17db..5024c4cb37 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 c8a78a4e65..69efd35d22 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 6d05dbf5e3..053e00009e 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 119ac97cbc..cdff2cf9b7 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 6f52f7ea72..6ba10018bc 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

        • Reject this variable's promise for the value with the given reason

          +

        Methods

        • Reject this variable's promise for the value with the given reason

          Parameters

          • reason: string

            This variable's promise will be rejected with this reason

          • throwIfAlreadySettled: boolean = false

            Determines whether to throw if the variable was already resolved or rejected

            -

          Returns void

        • Resolve this variable's promise to the given value

          +

        Returns void

        • Resolve this variable's promise to the given value

          Parameters

          • value: T

            This variable's promise will resolve to this value

          • throwIfAlreadySettled: boolean = false

            Determines whether to throw if the variable was already resolved or rejected

            -

          Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/DocumentCombinerEngine.html b/platform-bible-utils/classes/DocumentCombinerEngine.html index bf4a5809a4..87826fbe5f 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

          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

        • Throw an error if the provided document is not a valid contribution document.

          +
        • Throw an error if the provided document is not a valid contribution document.

          Parameters

          • documentName: string

            Name of the contributed document to combine

          • document: JsonDocumentLike

            Content of the contributed document to combine

            -

          Returns void

        • Throw an error if the provided output is not valid.

          +

        Returns void

        Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns void

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index e9777bc626..afb0159ccc 100644 --- a/platform-bible-utils/classes/Mutex.html +++ b/platform-bible-utils/classes/Mutex.html @@ -3,7 +3,7 @@

        Example

        const mutex = new Mutex();

        mutex.runExclusive(async () => {
        // Do some asynchronous stuff
        console.log('These run one-at-a-time');
        });

        mutex.runExclusive(async () => {
        // Do some asynchronous stuff
        console.log('These run one-at-a-time');
        });

        See async-mutex for more information.

        -

        Hierarchy

        Constructors

        Hierarchy

        • Mutex
          • Mutex

        Constructors

        Methods

        acquire cancel isLocked diff --git a/platform-bible-utils/classes/MutexMap.html b/platform-bible-utils/classes/MutexMap.html index 78259c7fdf..4d536df4fe 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,5 +1,5 @@ MutexMap | platform-bible-utils

        Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

        -

        Constructors

        Constructors

        Properties

        Methods

        get -

        Constructors

        Properties

        mutexesByID: Map<string, Mutex> = ...

        Methods

        Generated using TypeDoc

        \ No newline at end of file +

        Constructors

        Properties

        mutexesByID: Map<string, Mutex> = ...

        Methods

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index 8b4868c33a..8d4abea3b7 100644 --- a/platform-bible-utils/classes/PlatformEventEmitter.html +++ b/platform-bible-utils/classes/PlatformEventEmitter.html @@ -3,7 +3,7 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

        -

        Type Parameters

        • T

        Implements

        Constructors

        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>

        • Function that runs the subscriptions for the event. Added here so children can override emit +

        Returns void

        • Function that runs the subscriptions for the event. Added here so children can override emit and still call the base functionality. See NetworkEventEmitter.emit for example

          -

          Parameters

          • event: T

          Returns void

        Generated using TypeDoc

        \ No newline at end of file +

        Parameters

        • event: T

        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 0423d86d9f..ebdad2480d 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

        • Run all unsubscribers added to this list and then clear the list.

          Returns Promise<boolean>

          true if all unsubscribers succeeded, 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/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index 0ecec726e1..e683736449 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 a88d393702..ddffe06648 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 342ad992e9..2117128480 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 a786a2d5f1..f2831fc8ae 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 7286dd98ca..4280577ca7 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 b512c1b175..0377a38d76 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 8fc5a51c27..dde4404120 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 e24dc1061b..ea22a1c24e 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 b301d45536..ca22df1717 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        Generated using TypeDoc

        \ No newline at end of file +getChaptersForBook | platform-bible-utils

        Function getChaptersForBook

        Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 495e3de3f3..c49cb2ac4a 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 08a6438f38..3e7bd4be0d 100644 --- a/platform-bible-utils/functions/groupBy.html +++ b/platform-bible-utils/functions/groupBy.html @@ -2,4 +2,4 @@

        Type Parameters

        Parameters

        Returns Map<K, T[]>

        Map of keys to groups of values corresponding to each item

        -
      • Type Parameters

        • T

        • K

        • V

        Parameters

        • items: T[]
        • keySelector: ((item) => K)
            • (item): K
            • Parameters

              • item: T

              Returns K

        • valueSelector: ((item, key) => V)
            • (item, key): V
            • Parameters

              • item: T
              • key: K

              Returns V

        Returns Map<K, V[]>

      • Generated using TypeDoc

        \ No newline at end of file +
      • Type Parameters

        • T

        • K

        • V

        Parameters

        • items: T[]
        • keySelector: ((item) => K)
            • (item): K
            • Parameters

              • item: T

              Returns K

        • valueSelector: ((item, key) => V)
            • (item, key): V
            • Parameters

              • item: T
              • key: K

              Returns V

        Returns Map<K, V[]>

      • Generated using TypeDoc

        \ No newline at end of file diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index b65bcafecc..6695db5734 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 729976c368..dce26c4c0a 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 c538edcda2..ff1fd3d5ae 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 d8b6f5b789..dea564882f 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 d7c9a04746..8a4242ac73 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 e39b55f075..fe87287a4a 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 b1d5617c77..909ac7fc34 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 c05911a06a..041dc41227 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 480db73715..654bef2895 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 a6e2851e38..4c9ba00d63 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 a4c89d1749..34620ba210 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 983c9d51ca..ab7410737c 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 96975b7e35..ee49a76d29 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 3517141d4b..8f378e6167 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 960e4c9a7c..5b43cbef65 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 63e7ce2a0e..51dfe15a0c 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 501167ab1e..832975e89e 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 f8120509d8..d73546df9e 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 370efc57a5..e9f71e61ec 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 def3c0e053..a9173048a6 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 58fc6ea9b5..4dcfc9d08c 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 d2f8d891c6..3abe5f6a82 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 d43aa8efc4..d59dd6cc8b 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 fc0cf60f3e..20aafc94f6 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 19091a1008..b6dd093dd5 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 4f716dedb7..a64338c718 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 da64d0e146..4b0eaa2433 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 a0b8b1da01..7a9c256d81 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 ed3d501a45..ffae369a88 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 bfa9c59722..caea3f02b3 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 f0ae0f3716..020b677c1a 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 36d0b8424d..747198253e 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 c74c65d0fe..efc985810c 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 68ca5c2303..64b56f9945 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 416ccb2d18..8fb0363274 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 b5ca7c22d5..f77f7793fa 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 6642e8ea36..da23a5eaee 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 99ef8f2b72..db047dafa5 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 53b561a5fc..97237973dc 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 db5917c534..94791c41c0 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 5b2c874707..ad06b565f2 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 1c6b5955a1..f78830bef7 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 ce611b3da8..8f70d217bc 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 9cf0ead451..dee37d231a 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 f83e960e76..ac232b6d01 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