From 0251e6663faff32f5552a966ced9d78859f78662 Mon Sep 17 00:00:00 2001 From: irahopkinson Date: Mon, 8 Jul 2024 23:08:53 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20github-pages=20from=20@=20para?= =?UTF-8?q?next/paranext-core@ca8507d0bb162ec394438ee2b04288554711fe99=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 2 +- ...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 +- ..._model_.BaseProjectDataProviderEngine.html | 4 +- ...ider_engine_model_.DataProviderEngine.html | 4 +- ..._network_event_emitter_model_.default.html | 20 +++--- ...eringProjectDataProviderEngineFactory.html | 12 ++-- ...gine_model_.ProjectDataProviderEngine.html | 4 +- ...s_node_file_system_service_.EntryType.html | 4 +- ...al_connection_model_.ConnectionStatus.html | 8 +-- ..._network_connector_model_.MessageType.html | 4 +- ...shared_global_this_model_.ProcessType.html | 4 +- ...ls_web_view_model_.WebViewContentType.html | 8 +-- ...shared_utils_util_.RequestHandlerType.html | 4 +- papi-dts/functions/__papi_backend_.fetch.html | 4 +- .../functions/__papi_frontend_.fetch.html | 4 +- ...s_web_socket_factory_.createWebSocket.html | 2 +- ...e_service_.buildExtensionPathFromName.html | 2 +- ...ion_storage_service_.setExtensionUris.html | 2 +- ...es_node_file_system_service_.copyFile.html | 2 +- ...s_node_file_system_service_.createDir.html | 2 +- ...s_node_file_system_service_.deleteDir.html | 2 +- ..._node_file_system_service_.deleteFile.html | 2 +- ...es_node_file_system_service_.getStats.html | 2 +- ...ces_node_file_system_service_.readDir.html | 2 +- ...e_file_system_service_.readFileBinary.html | 2 +- ...ode_file_system_service_.readFileText.html | 2 +- ...vices_node_file_system_service_.touch.html | 2 +- ...s_node_file_system_service_.writeFile.html | 2 +- .../_node_utils_crypto_util_.createNonce.html | 2 +- .../_node_utils_crypto_util_.createUuid.html | 2 +- .../_node_utils_util_.getAppDir.html | 2 +- .../_node_utils_util_.getPathFromUri.html | 2 +- ...ls_util_.isNoisyDevModeEnvVariableSet.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 +- ...s_use_localized_strings_hook_.default.html | 2 +- ..._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 +- ...oviderFactoryMetadataInfoMinimalMatch.html | 2 +- ....getPDPFactoryIdFromNetworkObjectName.html | 2 +- ....getPDPFactoryNetworkObjectNameFromId.html | 2 +- ...up_service_model_.internalGetMetadata.html | 2 +- ...tMetadataForProjectParametersToFilter.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 +- ..._services_connection_service_.connect.html | 2 +- ...rvices_connection_service_.disconnect.html | 2 +- ...onnection_service_.emitEventOnNetwork.html | 2 +- ...vices_connection_service_.getClientId.html | 2 +- ..._services_connection_service_.request.html | 2 +- ...ices_data_provider_service_.getByType.html | 2 +- ...rovider_service_.registerEngineByType.html | 2 +- ...ed_services_logger_service_.formatLog.html | 2 +- ...ector_factory_.createNetworkConnector.html | 2 +- ...ect_service_.onDidCreateNetworkObject.html | 2 +- ...ct_service_.onDidDisposeNetworkObject.html | 2 +- ...twork_object_service_.overrideDispose.html | 2 +- ...rk_service_.createNetworkEventEmitter.html | 2 +- ...etwork_service_.createRequestFunction.html | 2 +- ...ices_network_service_.getNetworkEvent.html | 2 +- ..._services_network_service_.initialize.html | 2 +- ...s_network_service_.onDidClientConnect.html | 2 +- ...etwork_service_.onDidClientDisconnect.html | 2 +- ...twork_service_.registerRequestHandler.html | 2 +- ...red_services_network_service_.request.html | 2 +- ...ed_services_network_service_.shutdown.html | 2 +- ...es_project_data_provider_service_.get.html | 2 +- ...isterProjectDataProviderEngineFactory.html | 2 +- ...d_utils_internal_util_.getProcessType.html | 2 +- ..._shared_utils_internal_util_.isClient.html | 2 +- ..._utils_internal_util_.isExtensionHost.html | 2 +- ...hared_utils_internal_util_.isRenderer.html | 2 +- ..._shared_utils_internal_util_.isServer.html | 2 +- ...ared_utils_util_.createSafeRegisterFn.html | 2 +- ...ed_utils_util_.deserializeRequestType.html | 2 +- ...tils_util_.getModuleSimilarApiMessage.html | 2 +- .../_shared_utils_util_.newNonce.html | 2 +- ...ared_utils_util_.serializeRequestType.html | 2 +- .../functions/getSavedWebViewDefinition.html | 2 +- .../getSavedWebViewDefinitionById.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 +- ..._types_.ProjectDataProviderInterfaces.html | 4 +- ...api_shared_types_.ProjectSettingTypes.html | 10 +-- .../_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 +- ....NetworkObjectStatusRemoteServiceType.html | 4 +- ...model_.NetworkObjectStatusServiceType.html | 6 +- ...el_.IProjectDataProviderEngineFactory.html | 6 +- ...a_provider_factory_interface_.default.html | 8 +-- ...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 ++--- ...s_network_service_.PapiNetworkService.html | 6 +- ...PapiBackendProjectDataProviderService.html | 6 +- ...apiFrontendProjectDataProviderService.html | 4 +- ...ervice_model_.IProjectSettingsService.html | 8 +-- ...r_service_.PapiWebViewProviderService.html | 4 +- ...vider_service_.WebViewProviderService.html | 10 +-- ...iew_service_model_.WebViewServiceType.html | 8 +-- 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 +- ...api_hooks_use_localized_strings_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 +- ...e_project_data_provider_engine_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 +- ..._network_object_status_service_model_.html | 2 +- ...els_papi_network_event_emitter_model_.html | 2 +- ...t_data_provider_engine_factory_model_.html | 2 +- ...s_project_data_provider_engine_model_.html | 2 +- ...ject_data_provider_factory_interface_.html | 2 +- ...d_models_project_data_provider_model_.html | 2 +- ..._models_project_lookup_service_model_.html | 2 +- ...shared_models_project_metadata_model_.html | 2 +- .../_shared_models_web_view_model_.html | 2 +- ...hared_models_web_view_provider_model_.html | 2 +- .../_shared_services_command_service_.html | 2 +- .../_shared_services_connection_service_.html | 2 +- ...hared_services_data_provider_service_.html | 2 +- .../_shared_services_dialog_service_.html | 2 +- ...shared_services_dialog_service_model_.html | 2 +- .../_shared_services_internet_service_.html | 2 +- ...shared_services_localization_service_.html | 2 +- ..._services_localization_service_model_.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 +- .../_shared_services_network_service_.html | 2 +- ...rvices_project_data_provider_service_.html | 2 +- ...ared_services_project_lookup_service_.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 +- ...hared_types_.IBaseProjectDataProvider.html | 2 +- ...pi_shared_types_.IProjectDataProvider.html | 2 +- ...ared_types_.NotesOnlyProjectDataTypes.html | 2 +- ...pi_shared_types_.PlaceholderDataTypes.html | 2 +- ...ared_types_.ProjectInterfaceDataTypes.html | 2 +- ..._papi_shared_types_.ProjectInterfaces.html | 2 +- ...api_shared_types_.ProjectSettingNames.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 +- ...ition_model_.SelectBooksDialogOptions.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_.IBaseProjectDataProviderEngine.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 +- ...terface_.ProjectMetadataFilterOptions.html | 2 +- ...ta_provider_model_.ExtensionDataScope.html | 2 +- ...ider_model_.MandatoryProjectDataTypes.html | 2 +- ...ataProviderEngineExtensionDataMethods.html | 4 +- ...rvice_model_.ProjectLookupServiceType.html | 12 ++-- ...rojectDataProviderFactoryMetadataInfo.html | 2 +- ...oject_metadata_model_.ProjectMetadata.html | 2 +- ...el_.ProjectMetadataWithoutFactoryInfo.html | 2 +- ...view_model_.GetSavedWebViewDefinition.html | 2 +- ...els_web_view_model_.GetWebViewOptions.html | 2 +- ...eb_view_model_.SavedWebViewDefinition.html | 2 +- ...el_.SavedWebViewDefinitionOmittedKeys.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 +- ...n_service_model_.ILocalizationService.html | 6 +- ...ation_service_model_.LocalizationData.html | 2 +- ...vice_model_.LocalizationDataDataTypes.html | 2 +- ...n_service_model_.LocalizationSelector.html | 2 +- ..._service_model_.LocalizationSelectors.html | 2 +- ..._data_service_model_.IMenuDataService.html | 16 ++--- ...data_service_model_.MenuDataDataTypes.html | 2 +- ...s_network_service_.ArgsRequestHandler.html | 2 +- ...etwork_service_.ComplexRequestHandler.html | 2 +- ...twork_service_.ContentsRequestHandler.html | 2 +- ...e_model_.AllProjectSettingsValidators.html | 2 +- ...ervice_model_.ProjectSettingValidator.html | 2 +- ...l_.SimultaneousProjectSettingsChanges.html | 2 +- ...ttings_service_model_.AllSettingsData.html | 2 +- ..._service_model_.AllSettingsValidators.html | 2 +- ...tings_service_model_.ISettingsService.html | 10 +-- ...tings_service_model_.SettingDataTypes.html | 2 +- ...tings_service_model_.SettingValidator.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 +- ...ackend_.BaseProjectDataProviderEngine.html | 2 +- .../__papi_backend_.DataProviderEngine.html | 2 +- ...eringProjectDataProviderEngineFactory.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 +- .../__papi_backend_.localization.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_.settings.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 +- .../__papi_frontend_.localization.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 +- ...ition_model_.SELECT_BOOKS_DIALOG_TYPE.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 +- ...l_connection_model_.CLIENT_ID_UNKNOWN.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 +- ...LOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html | 2 +- ...kObjectStatusServiceNetworkObjectName.html | 2 +- ...ry_interface_.PDP_FACTORY_OBJECT_TYPE.html | 2 +- ...odel_.PROJECT_INTERFACE_PLATFORM_BASE.html | 2 +- ...RK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html | 2 +- ...rvice_model_.projectLookupServiceBase.html | 2 +- ...ce_model_.testingProjectLookupService.html | 2 +- ...SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html | 2 +- ...EW_DEFINITION_UPDATABLE_PROPERTY_KEYS.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 +- ...ervices_localization_service_.default.html | 2 +- ...del_.localizationServiceObjectToProxy.html | 2 +- ...odel_.localizationServiceProviderName.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 +- ...network_service_.papiNetworkService-1.html | 2 +- ...piBackendProjectDataProviderService-1.html | 2 +- ...iFrontendProjectDataProviderService-1.html | 2 +- ...vices_project_lookup_service_.default.html | 2 +- ...ces_project_settings_service_.default.html | 2 +- ...Y_EXTENSION_PROJECT_SETTING_VALIDATOR.html | 2 +- ...ojectSettingsServiceNetworkObjectName.html | 2 +- ..._.projectSettingsServiceObjectToProxy.html | 2 +- ...ed_services_settings_service_.default.html | 2 +- ....CATEGORY_EXTENSION_SETTING_VALIDATOR.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/isNoisyDevModeEnabled.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 +- .../functions/BookChapterControl.html | 2 +- platform-bible-react/functions/Button.html | 2 +- .../functions/ChapterRangeSelector.html | 2 +- platform-bible-react/functions/Checkbox.html | 2 +- platform-bible-react/functions/Checklist.html | 2 +- platform-bible-react/functions/ComboBox.html | 2 +- .../functions/ContextMenu.html | 2 +- .../functions/DropdownMenu.html | 2 +- .../functions/DropdownMenuCheckboxItem.html | 2 +- .../functions/DropdownMenuContent.html | 2 +- .../functions/DropdownMenuGroup.html | 2 +- .../functions/DropdownMenuItem.html | 2 +- .../functions/DropdownMenuLabel.html | 2 +- .../functions/DropdownMenuPortal.html | 2 +- .../functions/DropdownMenuRadioGroup.html | 2 +- .../functions/DropdownMenuRadioItem.html | 2 +- .../functions/DropdownMenuSeparator.html | 2 +- .../functions/DropdownMenuShortcut.html | 4 +- .../functions/DropdownMenuSub.html | 2 +- .../functions/DropdownMenuSubContent.html | 2 +- .../functions/DropdownMenuSubTrigger.html | 2 +- .../functions/DropdownMenuTrigger.html | 2 +- platform-bible-react/functions/GridMenu.html | 2 +- .../functions/HamburgerMenuButton.html | 2 +- .../functions/IconButton.html | 2 +- platform-bible-react/functions/Input.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/Tabs.html | 2 +- .../functions/TabsContent.html | 2 +- platform-bible-react/functions/TabsList.html | 2 +- .../functions/TabsTrigger.html | 2 +- platform-bible-react/functions/TextField.html | 2 +- platform-bible-react/functions/Toolbar.html | 2 +- .../functions/VerticalTabs.html | 2 +- .../functions/VerticalTabsContent.html | 2 +- .../functions/VerticalTabsList.html | 2 +- .../functions/VerticalTabsTrigger.html | 2 +- .../functions/buttonVariants.html | 2 +- platform-bible-react/functions/useEvent.html | 2 +- .../functions/useEventAsync.html | 2 +- .../functions/usePromise.html | 2 +- .../interfaces/ButtonProps.html | 6 +- .../interfaces/CommandHandler.html | 2 +- .../interfaces/MultiColumnMenuProvider.html | 2 +- .../interfaces/ScrRefSelectorProps.html | 4 +- .../interfaces/TableCalculatedColumn.html | 14 ++-- platform-bible-react/types/AnchorOrigin.html | 2 +- .../types/ChapterRangeSelectorProps.html | 2 +- platform-bible-react/types/CheckboxProps.html | 2 +- .../types/ChecklistProps.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 +- .../types/DropdownMenuCheckboxItemProps.html | 2 +- .../types/DropdownMenuContentProps.html | 2 +- .../types/DropdownMenuItemProps.html | 2 +- .../types/DropdownMenuLabelProps.html | 2 +- .../types/DropdownMenuRadioItemProps.html | 2 +- .../types/DropdownMenuSeparatorProps.html | 2 +- .../types/DropdownMenuShortcutProps.html | 2 +- .../types/DropdownMenuSubContentProps.html | 2 +- .../types/DropdownMenuSubTriggerProps.html | 2 +- platform-bible-react/types/GridMenuInfo.html | 2 +- platform-bible-react/types/GridMenuProps.html | 2 +- .../types/IconButtonProps.html | 2 +- .../types/MenuItemListProps.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 ++-- platform-bible-utils/classes/Collator.html | 8 +-- .../classes/DateTimeFormat.html | 14 ++-- .../classes/DocumentCombiner.html | 28 ++++---- platform-bible-utils/classes/Mutex.html | 2 +- platform-bible-utils/classes/MutexMap.html | 4 +- .../NonValidatingDocumentCombiner.html | 28 ++++---- .../classes/NumberFormat.html | 14 ++-- .../classes/PlatformEventEmitter.html | 22 +++--- .../classes/UnsubscriberAsyncList.html | 8 +-- .../aggregateUnsubscriberAsyncs.html | 2 +- .../functions/aggregateUnsubscribers.html | 2 +- platform-bible-utils/functions/at.html | 2 +- platform-bible-utils/functions/charAt.html | 2 +- .../functions/codePointAt.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 +- platform-bible-utils/functions/endsWith.html | 2 +- .../functions/escapeStringRegexp.html | 2 +- .../functions/formatReplacementString.html | 2 +- .../functions/getAllObjectFunctionNames.html | 2 +- .../functions/getChaptersForBook.html | 2 +- .../functions/getCurrentLocale.html | 2 +- .../functions/getErrorMessage.html | 2 +- .../getLocalizedIdFromBookNumber.html | 2 +- platform-bible-utils/functions/groupBy.html | 2 +- .../functions/htmlEncode.html | 2 +- platform-bible-utils/functions/includes.html | 2 +- platform-bible-utils/functions/indexOf.html | 2 +- .../functions/isLocalizeKey.html | 2 +- .../functions/isSerializable.html | 2 +- platform-bible-utils/functions/isString.html | 2 +- platform-bible-utils/functions/isSubset.html | 2 +- .../functions/lastIndexOf.html | 2 +- platform-bible-utils/functions/newGuid.html | 2 +- platform-bible-utils/functions/normalize.html | 2 +- .../functions/offsetBook.html | 2 +- .../functions/offsetChapter.html | 2 +- .../functions/offsetVerse.html | 2 +- .../functions/ordinalCompare.html | 2 +- platform-bible-utils/functions/padEnd.html | 2 +- platform-bible-utils/functions/padStart.html | 2 +- platform-bible-utils/functions/serialize.html | 2 +- platform-bible-utils/functions/slice.html | 2 +- platform-bible-utils/functions/split.html | 2 +- .../functions/startsWith.html | 2 +- .../functions/stringLength.html | 2 +- platform-bible-utils/functions/substring.html | 2 +- platform-bible-utils/functions/toArray.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/LanguageStrings.html | 2 +- .../LocalizedStringDataContribution.html | 4 +- .../ModifierExtensionControlled.html | 4 +- .../interfaces/ModifierProject.html | 10 +-- .../interfaces/OnDidDispose.html | 4 +- .../interfaces/ProjectSettingProperties.html | 2 +- .../interfaces/ProjectSettingsGroup.html | 6 +- .../interfaces/ProjectStateContribution.html | 2 +- .../interfaces/ScriptureReference.html | 4 +- .../interfaces/SettingProperties.html | 2 +- .../interfaces/SettingsGroup.html | 6 +- .../interfaces/StateBase.html | 6 +- .../interfaces/StringMetadata.html | 6 +- .../interfaces/StringsMetadata.html | 2 +- .../interfaces/UserStateContribution.html | 2 +- .../types/CanHaveOnDidDispose.html | 2 +- .../types/ColumnsWithHeaders.html | 2 +- platform-bible-utils/types/DeepPartial.html | 2 +- .../types/DocumentCombinerOptions.html | 2 +- .../ExtensionControlledProjectSetting.html | 2 +- .../types/ExtensionControlledSetting.html | 2 +- .../types/ExtensionControlledState.html | 2 +- .../types/GroupsInMultiColumnMenu.html | 2 +- .../types/GroupsInSingleColumnMenu.html | 2 +- .../types/JsonDocumentLike.html | 2 +- platform-bible-utils/types/LocalizeKey.html | 2 +- platform-bible-utils/types/Localized.html | 2 +- .../types/LocalizedStringValue.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/ProjectSetting.html | 2 +- .../types/ProjectSettingBase.html | 2 +- .../types/ProjectSettingsContribution.html | 2 +- .../types/ReferencedItem.html | 2 +- platform-bible-utils/types/ReplaceType.html | 2 +- platform-bible-utils/types/Setting.html | 2 +- platform-bible-utils/types/SettingBase.html | 2 +- .../types/SettingsContribution.html | 2 +- .../types/SingleColumnMenu.html | 2 +- .../types/UnionToIntersection.html | 2 +- platform-bible-utils/types/Unsubscriber.html | 2 +- .../types/UnsubscriberAsync.html | 2 +- platform-bible-utils/types/UserState.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 +- .../localizedStringsDocumentSchema.html | 2 +- .../variables/menuDocumentSchema.html | 2 +- .../projectSettingsDocumentSchema.html | 2 +- .../variables/settingsDocumentSchema.html | 2 +- 671 files changed, 945 insertions(+), 945 deletions(-) diff --git a/index.html b/index.html index f09a9faa20..88a56ae563 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ - + 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 5c5ca82577..532b625cd8 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.
  • @@ -34,59 +34,59 @@

MUST ALSO RUN notifyClientConnected() WHEN PROMISE RESOLVES

Type declaration

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>

handleEventMessage: any

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

Type declaration

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

      • T

      Parameters

      Returns Promise<void>

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

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

+
\ 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 f8faec1a0b..454a495386 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.
  • @@ -43,77 +43,77 @@

MUST ALSO RUN notifyClientConnected() WHEN PROMISE RESOLVES

Type declaration

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>

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

Type declaration

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

      • T

      Parameters

      Returns Promise<void>

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

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

+
\ 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 2a0cc0bb71..3ad9c9d664 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

\ No newline at end of file +

Constructors

Properties

name: string
nonce: string
type: "extension"

Methods

\ 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 961e1d2d72..f5d66ce524 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
\ 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
\ 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 422116ec8c..e99bfd0101 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
\ 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
\ No newline at end of file diff --git a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html index af7fa83fee..9d6b8f60aa 100644 --- a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html @@ -6,6 +6,6 @@
this.notifyUpdate('Setting');
 

See

IBaseProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Constructors

Type Parameters

Hierarchy (view full)

Constructors

Methods

Constructors

Methods

\ No newline at end of file +

Constructors

Methods

\ 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 bffc003747..603d062e0b 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

\ No newline at end of file +

Constructors

Methods

\ 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 1d8a5e6271..359f1276b4 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

  • get event(): PlatformEvent<T>
  • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

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

Methods

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

  • 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

  • Runs only the subscriptions for the event that are on this process. Does not send over network

    +

    Parameters

    • event: T

    Returns void

  • Runs only the subscriptions for the event that are on this process. Does not send over network

    Parameters

    • event: T

      Event data to provide to subscribed callbacks

      -

    Returns void

\ No newline at end of file +

Returns void

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

-

Type Parameters

Constructors

Type Parameters

Constructors

Properties

pdpfId: string
pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

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

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

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

Properties

pdpfId: string
pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

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

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

  • Include one
  • Include both two and three.
  • -
    providedProjectInterfaces: SupportedProjectInterfaces

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

    +
    providedProjectInterfaces: SupportedProjectInterfaces

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

    Example

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

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

    -

    Methods

    Methods

    \ No newline at end of file +

    Parameters

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    \ 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 10c9aa8a32..e2753ace68 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html @@ -6,6 +6,6 @@
    this.notifyUpdate('Setting');
     

    See

    IProjectDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    Type Parameters

    Hierarchy (view full)

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ 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 cd40a53eab..6e9a9f2bbb 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"
    \ No newline at end of file +

    Enumeration Members

    Directory: "directory"
    File: "file"
    Unknown: "unknown"
    \ 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 3069bd31ec..3e5c5705bd 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

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

    +
    \ 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 944ad71632..9802d1f70a 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"
    \ No newline at end of file +

    Enumeration Members

    ClientConnect: "client-connect"
    Event: "event"
    InitClient: "init-client"
    Request: "request"
    Response: "response"
    \ 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 3ec5c438b5..3f6a477a53 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"
    \ No newline at end of file +

    Enumeration Members

    ExtensionHost: "extension-host"
    Main: "main"
    Renderer: "renderer"
    \ 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 0c51e63ed2..58888ec410 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.

    -
    \ No newline at end of file +
    \ 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 c89c102ec0..c5a65ccc99 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"
    \ No newline at end of file +

    Enumeration Members

    Args: "args"
    Complex: "complex"
    Contents: "contents"
    \ 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 944b956229..5ac1c0c753 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>

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

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

    Returns Promise<Response>

  • \ 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 f98e66aba1..1d84a9ac35 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>

    \ No newline at end of file +

    Parameters

    Returns Promise<Response>

  • This is just an alias for internet.fetch

    +

    Parameters

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

    Returns Promise<Response>

  • \ 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 750b7ebe32..64d49e8830 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

      -
    \ No newline at end of file +
    \ 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 5062bfca48..3cb805f7ea 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

    \ No newline at end of file +

    Parameters

    Returns string

    \ 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 4a3b60bc1b..f83a987dbc 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

    \ No newline at end of file +

    Parameters

    Returns void

    \ 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 aa6bf23033..f817b33de0 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>

    \ No newline at end of file +

    Returns Promise<void>

    \ 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 8bfa401c44..b12d3346cc 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

      -
    \ No newline at end of file +
    \ 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 77980ce8ce..e12516e138 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

      -
    \ No newline at end of file +
    \ 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 ba2b25288f..d3007c8644 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

      -
    \ No newline at end of file +
    \ 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 8e002d1458..40a2b7b3c8 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

    -
    \ No newline at end of file +
    \ 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 70502ba520..6491d6585c 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.

    -
    \ No newline at end of file +
    \ 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 8a932e18b5..b155e50480 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

      -
    \ No newline at end of file +
    \ 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 65dc44ccf2..a520c46811 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

      -
    \ No newline at end of file +
    \ 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 c0f1406236..fd7c3f0a2e 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

      -
    \ No newline at end of file +
    \ 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 5e28c95aaa..988fadaac6 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

    -
    \ No newline at end of file +
    \ 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 8c458ad167..8c349bfa17 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
    \ No newline at end of file +
    \ 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 6b0f221e00..72a0728ed6 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
    \ No newline at end of file +createUuid | papi-dts
    \ 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 062e568c6b..54bd425827 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

    \ 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 5fa2a750f9..18d4b627de 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

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

    Function isNoisyDevModeEnvVariableSet

    • Determines if running in noisy dev mode

      Returns boolean

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

      -
    \ No newline at end of file +
    \ 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 40f9d2efc7..88224383e8 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

    -
    \ No newline at end of file +
    \ 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 e4df92666f..8527e13b1d 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts
    \ No newline at end of file +resolveHtmlPath | papi-dts
    \ 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 af98a9c2c9..0af2035786 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

    \ No newline at end of file +

    Returns void

    \ 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 56efd60465..c091e38bfe 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

    -
    \ No newline at end of file +
    \ 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 17d3aa77d2..47979f2c6d 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

    -
    \ No newline at end of file +
    \ 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 741afb6222..a846e0294b 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])
    }

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

    \ 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 eae3062ac3..04188d19ee 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

    -
    \ No newline at end of file +
    \ 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 86dad7da0b..d4aff72281 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.

    -
    \ No newline at end of file +
    \ 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 d33df341fc..208e707fd5 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
  • -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html index caa41e0b8f..29b47a7ace 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html @@ -15,4 +15,4 @@
  • localizedStrings: The current state of the localizations, either defaultState or the stored state on the papi, if any
  • -
    \ No newline at end of file +
    \ 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 6649daf235..8d06c7b2b8 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html @@ -37,4 +37,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -

    Type Parameters

    Parameters

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

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    \ 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 d834bd5d59..d5ca10c7ea 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html @@ -12,4 +12,4 @@

    Returns undefined | ProjectDataProviderInterfaces[ProjectInterface]

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

    -
    \ No newline at end of file +
    \ 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 af136471ca..16c4bfec34 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html @@ -30,4 +30,4 @@

    Throws

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

    -
    \ No newline at end of file +
    \ 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 b41c1dba92..0c8a97e4b2 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

    -
    \ No newline at end of file +
    \ 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 e0ce5ebdcf..bca2ab2af5 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

    \ No newline at end of file +

    Returns void

    \ 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 81ea3840f8..e6419cdb32 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
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html index 1004debfeb..92edb80c74 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html @@ -5,4 +5,4 @@

    Parameters

    Returns -1 | 0 | 1

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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html index 7061130807..647feaeff5 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html @@ -1,4 +1,4 @@ getPDPFactoryIdFromNetworkObjectName | papi-dts
    • Transform a network object id for a pdp factory into its well-known pdp factory id

      Parameters

      • pdpFactoryNetworkObjectName: string

        Id for then network object for this pdp factory

      Returns string

      Id extensions use to identify this pdp factory

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html index a6d9d6981d..9cd534eead 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html @@ -1,4 +1,4 @@ getPDPFactoryNetworkObjectNameFromId | papi-dts
    • Transform the well-known pdp factory id into an id for its network object to use

      Parameters

      • pdpFactoryId: string

        Id extensions use to identify this pdp factory

      Returns string

      Id for then network object for this pdp factory

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

    -

    Parameters

    Returns Promise<ProjectMetadata[]>

    \ No newline at end of file +

    Parameters

    Returns Promise<ProjectMetadata[]>

    \ No newline at end of file diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html index 115b72828a..69e97a5db4 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html @@ -1 +1 @@ -transformGetMetadataForProjectParametersToFilter | papi-dts
    • Parameters

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

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

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined
    \ No newline at end of file +transformGetMetadataForProjectParametersToFilter | papi-dts
    • Parameters

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

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

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined
    \ 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 79536e0337..86dbab0abe 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

    -
    \ No newline at end of file +
    \ 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 fdc96265d5..9d5811adfb 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>

    \ No newline at end of file +

    Returns Promise<void>

    \ 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 5409e374f2..65a64ffd70 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

    -
    \ No newline at end of file +
    \ 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 7934fe6b30..043f28c82e 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
    \ No newline at end of file +

    Type Parameters

    Parameters

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

    \ 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 eee5a8226e..4775695a02 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

    -
    \ No newline at end of file +
    \ 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 7bce8892a6..d5ebbf8d56 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
    \ No newline at end of file +

    Returns void

    \ 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 ae81be6089..647576ec65 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>

    \ No newline at end of file +

    Returns Promise<void>

    \ 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 7bba16d3cb..892dda85ba 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
    \ No newline at end of file +

    Returns number

    \ 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 a6c24f7763..015d0e1d3a 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

    -
    \ No newline at end of file +
    \ 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 e9125eea1a..8ebd972fd5 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

      -
    \ No newline at end of file +
    \ 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 445f5d827a..ad3b6592ba 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.

    -
    \ No newline at end of file +
    \ 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 2316da7546..7f79b28394 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

    -
    \ No newline at end of file +
    \ 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 afeb37717d..31539c8dd2 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
    \ No newline at end of file +
    \ 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 fa786027a1..3d0937014f 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

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ 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 550c8d3c2f..f092a9e4c4 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

    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ 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 7896efdd81..a0ff66ef81 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

    \ No newline at end of file +

    Parameters

    Returns void

    \ 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 4b826d504e..3c3bdfbd6e 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

    -
    \ No newline at end of file +
    \ 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 cc101927c8..72cea224e9 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

    -
    \ No newline at end of file +
    \ 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 9e0119e875..0c557af6ce 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

      -
    \ No newline at end of file +
    \ 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 7a9aad6923..dca9731093 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
    \ No newline at end of file +

    Returns Promise<void>

    \ 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 3e4c898f3d..2684b5b8c3 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
    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ 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 162d3bbc7b..15c6885368 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
    \ No newline at end of file +

    Parameters

    Returns Unsubscriber

    \ 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 2b58cdbc2f..f421a58be9 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>

  • \ No newline at end of file +
  • Parameters

    Returns Promise<UnsubscriberAsync>

  • Parameters

    Returns Promise<UnsubscriberAsync>

  • \ 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 6892f14930..a5989fa005 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

    -
    \ No newline at end of file +
    \ 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 d7940d7bef..2735ead5ef 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
    \ No newline at end of file +

    Returns void

    \ 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 72c11796d2..1293194313 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html @@ -12,4 +12,4 @@

    Throws

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

    -
    \ No newline at end of file +
    \ 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 8e84699a7c..2785f7cda2 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html @@ -5,4 +5,4 @@ should be available on the PDPEs created by this factory.

  • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

    Used in a ProjectDataProviderFactory to create ProjectDataProviders

  • Returns Promise<Dispose>

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

    -
    \ No newline at end of file +
    \ 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 b8218eff6a..6c9dd00e71 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
    \ No newline at end of file +
    \ 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 096f481459..adc7a2d97f 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

      -
    \ No newline at end of file +
    \ 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 7a8c016a95..bafe17165a 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

      -
    \ No newline at end of file +
    \ 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 30e94af1ea..94650de343 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

      -
    \ No newline at end of file +
    \ 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 167e796cbb..358d16fa4a 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

      -
    \ No newline at end of file +
    \ 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 a8e35c1dd4..6c2cac62aa 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)

    -
    \ No newline at end of file +
    \ 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 f1bb0be8b9..47b5f4e417 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
    \ No newline at end of file +

    Parameters

    Returns RequestType

    \ 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 1f6469d440..b91c143dcb 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

      -
    \ No newline at end of file +
    \ 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 adbf37b5c4..f604dbb948 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

    \ No newline at end of file +

    Returns string

    \ 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 db70259359..c0d4306e49 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

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

    Function getSavedWebViewDefinition

    \ No newline at end of file +

    Returns undefined | SavedWebViewDefinition

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

    Function getSavedWebViewDefinitionById

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

    Function getSavedWebViewDefinitionById

    \ No newline at end of file diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index c183fdc6ea..1d79449aeb 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

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns T

    \ No newline at end of file diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index 317afcdc6d..0a5d9a801b 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

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index 1e8822c0cb..c309566daf 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

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns void

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

    @example

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

    Parameters

    Returns boolean

    \ No newline at end of file +

    Parameters

    Returns boolean

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

    Function updateWebViewDefinitionById

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

    Function updateWebViewDefinitionById

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

    \ No newline at end of file +

    Type Parameters

    Parameters

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

    \ No newline at end of file diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index 6edaa3ed3a..ae8edc7bc2 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 2fa1e404e3..144ca65c6b 100644 --- a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html +++ b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html @@ -1,10 +1,10 @@ IExtension | papi-dts

    Interface 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

    Type declaration

      • (context): Promise<void>
      • Parameters

        Returns Promise<void>

    deactivate?: UnsubscriberAsync

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

    Returns Promise<void>

    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

    -
    \ No newline at end of file +
    \ 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 2bdd98c516..06cc4fa32f 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

        -
    \ No newline at end of file +
    \ 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 985ad6ed26..9fedb40c61 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -6,11 +6,11 @@ following to its .d.ts file:

    Example

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

    Properties

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

    Properties

    platform.quit: (() => 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.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

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

    \ 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 aa8b126693..d2fc1de200 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>;
    }
    \ No newline at end of file +

    Properties

    \ No newline at end of file diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html index bb61865fe7..b4707f1681 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html @@ -33,10 +33,10 @@ MyExtensionLayeringProjectInterface projectInterface):

    Example

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

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

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

    Properties

    Properties

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

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

    -
    \ No newline at end of file +
    \ 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 98a5462567..08a9f5b389 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -9,22 +9,22 @@ myExtension.highlightColor project setting):

    Example

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

    Properties

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

    Properties

    platform.fullName: string

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

    Example

    'World English Bible'
     
    -
    platform.isEditable: boolean

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

    platform.isEditable: boolean

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

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

    -
    platform.language: 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'
     
    -
    platform.name: string

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

    platform.name: string

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

    Example

    'WEB'
     
    -
    \ No newline at end of file +
    \ 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 33ff5d4f60..148548b1c0 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
    \ No newline at end of file +

    Properties

    platform.interfaceLanguage: string[]
    platform.verseRef: ScriptureReference
    \ 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 f96c9e1979..e9f6b193b8 100644 --- a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html +++ b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html @@ -1,7 +1,7 @@ DialogTypes | papi-dts

    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.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>
    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>
    \ No newline at end of file +

    Properties

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>
    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>
    \ 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 60d5ed845b..af867884f9 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"
    \ No newline at end of file +

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +
    type: "float"
    \ 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 66b984f5b3..5b7e8fe7ff 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"
    \ 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"
    \ 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 eadece43ca..d6a6531c4c 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"
    \ No newline at end of file +
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type: "tab"
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index e9e36f0526..ea9898159e 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html @@ -1,5 +1,5 @@ -NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        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

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

    Provides functions related to the set of available network objects

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

    Hierarchy (view full)

    Properties

    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((objectDetailsToMatch, 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: ((objectDetailsToMatch, timeoutInMS?) => Promise<NetworkObjectDetails>)

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

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

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

    Type declaration

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

        • objectDetailsToMatch: Partial<NetworkObjectDetails>

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

        • Optional timeoutInMS: number

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

        Returns Promise<NetworkObjectDetails>

    Returns

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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html index 10f8c4130f..9cfdf61f66 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html @@ -20,7 +20,7 @@

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

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

    Type Parameters

    Methods

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

    Type Parameters

    Methods

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

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

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

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    \ No newline at end of file +

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    \ No newline at end of file diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html index b73dc5cfbf..44f47c3113 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html @@ -6,11 +6,11 @@ and provide additional projectInterfaces on those projects (Layering PDP Factory). Base PDP Factories must create PDPs that support the platform.base projectInterface. See IBaseProjectDataProvider and ProjectDataProviderInterfaces for more information.

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

    Hierarchy

    Properties

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

    Hierarchy

    • Dispose
      • default

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

    Methods

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

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

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

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

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

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

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

      Parameters

      • projectId: string

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

      Returns Promise<string>

      Id of the project data provider this IProjectDataProviderFactory created for this project id. It should return the same project data provider for the same combination of parameters throughout one session (in other words, in general, there should just be one project data provider for one project id).

      -
    \ No newline at end of file +
    \ 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 a4b164f9ef..d8e37f948e 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

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

    \ 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 340e2a3a4c..1f4437c876 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

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

    \ 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 28ab4ff2dc..43acca7b46 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

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

    \ 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 9b42558416..fb257fc1b2 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.

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

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

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

      -
    get: (<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

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

    Type declaration

      • (providerName): boolean
      • 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

    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.

    -
    \ No newline at end of file +
    \ 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 012edcb8f4..5694fdbf70 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

      -
    \ No newline at end of file +
    \ 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 92f3a96147..3c0c515b26 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>

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

  • \ 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 2579ad79ff..9a54ab4d71 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

  • networkConnectorEventHandlers: NetworkConnectorEventHandlers

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

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

    Returns

    Promise that resolves with connector info when finished connecting

    -
    connectionStatus: ConnectionStatus

    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

        • eventType: string

          Unique network event type for coordinating between processes

        • event: InternalEvent<T>

          Event to emit on the network

          -

        Returns Promise<void>

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

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

    +

    Returns Promise<void>

    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>

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

    +

    Type declaration

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

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

    Param: requestType

    The type of request

    Param: contents

    Contents to send in the request

    Returns

    Promise that resolves with the response message

    -
    \ No newline at end of file +
    \ 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 29985cf8c7..bf072c3269 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>
    \ No newline at end of file +
    onDidClientConnect: PlatformEvent<ClientConnectEvent>
    onDidClientDisconnect: PlatformEvent<ClientDisconnectEvent>
    \ 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 9d418e4011..cc553dbfa1 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: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory) => Promise<Dispose>);
    }

    Properties

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

    Properties

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

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

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

          Throws

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

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

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

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

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        Type Parameters

        Parameters

        • pdpFactoryId: string

          Unique id for this PDP factory

        • projectInterfaces: SupportedProjectInterfaces

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

        • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

          Used in a ProjectDataProviderFactory to create ProjectDataProviders

        Returns Promise<Dispose>

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

        -
    \ No newline at end of file +
    \ 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 961104e41e..96f9b2d70a 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: (<ProjectInterface>(projectInterface, projectId, pdpFactoryId?) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

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

    Properties

    Properties

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

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

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

          Throws

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

          -
    \ No newline at end of file +
    \ 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 f5529b7ef2..781ca58b54 100644 --- a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html +++ b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html @@ -1,5 +1,5 @@ IProjectSettingsService | papi-dts

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

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

    Methods

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

    Methods

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

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

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

      The current project setting value

    • Optional allChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -
    \ No newline at end of file +
    \ 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 114d486820..9e6a205249 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

        -
    \ No newline at end of file +
    \ 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 7e2d367c8c..5a86282848 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

        -
    \ No newline at end of file +
    \ 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 afe017d877..da0f099ea3 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>;
        getSavedWebViewDefinition(webViewId): Promise<undefined | SavedWebViewDefinition>;
    }

    Properties

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

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

    Returns Promise<undefined | string>

    Returns

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

    Throws

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

    -
    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    -

    Methods

    onDidAddWebView: PlatformEvent<AddWebViewEvent>

    Event that emits with webView info when a webView is added

    +

    Methods

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

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

      Throws

      If something went wrong like the provider for the webViewType

      Parameters

      • webViewId: string

        The ID of the WebView whose saved properties to get

      Returns Promise<undefined | SavedWebViewDefinition>

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

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

    Namespace "@papi/backend"

    Index

    Variables

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

    Namespace "@papi/backend"

    Index

    Variables

    BaseProjectDataProviderEngine DataProviderEngine LayeringProjectDataProviderEngineFactory ProjectDataProviderEngine diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 6158952eac..01cae22013 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 d003664d18..1b3170d6d3 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 30f8bd1d25..145893f79b 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 3898c6107e..ce6d631e51 100644 --- a/papi-dts/modules/_client_services_client_network_connector_service_.html +++ b/papi-dts/modules/_client_services_client_network_connector_service_.html @@ -1,2 +1,2 @@ -"client/services/client-network-connector.service" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    \ 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 3ae4328b12..2fc7c2dfd0 100644 --- a/papi-dts/modules/_client_services_web_socket_factory_.html +++ b/papi-dts/modules/_client_services_web_socket_factory_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.factory" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 6a9920c4d3..88472a0087 100644 --- a/papi-dts/modules/_client_services_web_socket_interface_.html +++ b/papi-dts/modules/_client_services_web_socket_interface_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.interface" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    \ 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 6f1c22acee..46db31b355 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-activation-context.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    \ 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 982b9db8be..ba48787904 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension.interface" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    \ 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 eddd6d8733..43c56abd1f 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-manifest.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    \ 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 47738bfbe8..7945e2d78a 100644 --- a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html +++ b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html @@ -1,3 +1,3 @@ -"extension-host/services/extension-host-web-socket.model" | papi-dts

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

    Index

    Namespaces

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

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

    Index

    Namespaces

    Classes

    \ 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 c945f79298..572c55f64b 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 44f48013ea..e116876195 100644 --- a/papi-dts/modules/_main_services_server_network_connector_service_.html +++ b/papi-dts/modules/_main_services_server_network_connector_service_.html @@ -1,2 +1,2 @@ -"main/services/server-network-connector.service" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    \ 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 ae76307859..d87539bdae 100644 --- a/papi-dts/modules/_node_models_execution_token_model_.html +++ b/papi-dts/modules/_node_models_execution_token_model_.html @@ -1,3 +1,3 @@ -"node/models/execution-token.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    Type Aliases

    \ 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 e8d807edc6..1a2a2702dc 100644 --- a/papi-dts/modules/_node_services_execution_token_service_.html +++ b/papi-dts/modules/_node_services_execution_token_service_.html @@ -1,2 +1,2 @@ -"node/services/execution-token.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    \ 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 b5debbd75b..c608a292d9 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 ba54099bc8..69fd7f8703 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

    Namespace "node/utils/crypto-util"

    Index

    Functions

    \ 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 65bfa4861e..047de7b4cf 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 277b72b914..37bb0d3831 100644 --- a/papi-dts/modules/_papi_shared_types_.html +++ b/papi-dts/modules/_papi_shared_types_.html @@ -1,4 +1,4 @@ -"papi-shared-types" | papi-dts

    Namespace "papi-shared-types"

    Index

    Interfaces

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

    Namespace "papi-shared-types"

    Index

    Interfaces

    CommandHandlers DataProviders ProjectDataProviderInterfaces ProjectSettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index 630f7b4696..4c018c02dc 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 bf8ebe401d..bcba32443f 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 4250c1ff06..d4c82855fe 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 d8bb3a4dc9..c026f4cc4a 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 96a07e6d8a..f6a09f8f01 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 bc20b4ed56..75dc9aa964 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 623d45ce03..07239c5aff 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 22a4880ce2..6dd1045ccf 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 2d0474e970..65dbf0a5ec 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html @@ -1,3 +1,3 @@ -"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    Functions

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

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 90d636834c..7e6ec93571 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 0f2efacb3c..f943376674 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 c8883dd598..d728209f68 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 bc7b1e632a..ca8eaa31b5 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 08ef4f7cc3..16e4dd0419 100644 --- a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html @@ -1,3 +1,3 @@ -"renderer/services/renderer-web-socket.service" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    Functions

    \ 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 cb5bc09f83..551b1f8244 100644 --- a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html @@ -1,2 +1,2 @@ -"renderer/services/renderer-xml-http-request.service" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    \ 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 843f73262f..04c668d0bf 100644 --- a/papi-dts/modules/_shared_data_file_system_model_.html +++ b/papi-dts/modules/_shared_data_file_system_model_.html @@ -1,2 +1,2 @@ -"shared/data/file-system.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    \ 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 01910a11e4..e3dac8de13 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 f17c554b76..8dead2c3ec 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 3b6f5cb8ff..2098615857 100644 --- a/papi-dts/modules/_shared_global_this_model_.html +++ b/papi-dts/modules/_shared_global_this_model_.html @@ -1,2 +1,2 @@ -"shared/global-this.model" | papi-dts

    Namespace "shared/global-this.model"

    Index

    Enumerations

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

    Namespace "shared/global-this.model"

    Index

    Enumerations

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

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

    Index

    Classes

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

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

    Index

    Classes

    Type Aliases

    \ 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 107aeada52..3d7a29b667 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 4fa90bfbb5..2a1283544b 100644 --- a/papi-dts/modules/_shared_models_data_provider_interface_.html +++ b/papi-dts/modules/_shared_models_data_provider_interface_.html @@ -1,3 +1,3 @@ -"shared/models/data-provider.interface" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    \ 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 3c2a178966..e4f6560c6c 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 80a032e986..b1e1b20480 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,4 +1,4 @@ -"shared/models/dialog-options.model" | papi-dts

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

    Index

    Type Aliases

    DialogData +"shared/models/dialog-options.model" | papi-dts
    \ 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 012bcd988c..4222582780 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 9f5b4227a1..360bd83d91 100644 --- a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html +++ b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html @@ -1,2 +1,2 @@ -"shared/models/extract-data-provider-data-types.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    \ 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 5e1b03ae3b..0d90769992 100644 --- a/papi-dts/modules/_shared_models_network_object_model_.html +++ b/papi-dts/modules/_shared_models_network_object_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    DisposableNetworkObject LocalObjectToProxyCreator NetworkObject NetworkObjectDetails diff --git a/papi-dts/modules/_shared_models_network_object_status_service_model_.html b/papi-dts/modules/_shared_models_network_object_status_service_model_.html index 9d25171fe2..0ee82f0841 100644 --- a/papi-dts/modules/_shared_models_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_models_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object-status.service-model" | papi-dts

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

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType +"shared/models/network-object-status.service-model" | papi-dts
    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html index 5a5ad1c9dc..8bf1fffd85 100644 --- a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html +++ b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html @@ -1,2 +1,2 @@ -"shared/models/papi-network-event-emitter.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

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

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

    Index

    Classes

    LayeringProjectDataProviderEngineFactory +"shared/models/project-data-provider-engine-factory.model" | papi-dts
    \ 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 4ef22ef2ed..745c2d0556 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

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

    Index

    Classes

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

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

    Index

    Classes

    Type Aliases

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html index 8b6ee51492..46f7b5aa49 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider-factory.interface" | papi-dts

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

    Index

    Interfaces

    default +"shared/models/project-data-provider-factory.interface" | papi-dts

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

    Index

    Interfaces

    Type Aliases

    Variables

    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_project_data_provider_model_.html b/papi-dts/modules/_shared_models_project_data_provider_model_.html index 3348bf9af7..25c066a435 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider.model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    Variables

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

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    Variables

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE projectLookupServiceBase testingProjectLookupService diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index 89c5d3f7fe..743b2a0445 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-metadata.model" | papi-dts

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

    Index

    Type Aliases

    ProjectDataProviderFactoryMetadataInfo +"shared/models/project-metadata.model" | papi-dts
    \ No newline at end of file diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index affb9117ee..08f2135f80 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

    GetSavedWebViewDefinition GetWebViewOptions SavedWebViewDefinition diff --git a/papi-dts/modules/_shared_models_web_view_provider_model_.html b/papi-dts/modules/_shared_models_web_view_provider_model_.html index 723ca7a637..19ba4e9f26 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
    \ 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 4ac776dd9a..ef1adb3e34 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

    createSendCommandFunction initialize registerCommand diff --git a/papi-dts/modules/_shared_services_connection_service_.html b/papi-dts/modules/_shared_services_connection_service_.html index 4ffd705b98..4e1b65cd7a 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 e39f9defe4..5833c12c8e 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 1d37565a5c..53e1f81c6e 100644 --- a/papi-dts/modules/_shared_services_dialog_service_.html +++ b/papi-dts/modules/_shared_services_dialog_service_.html @@ -1,2 +1,2 @@ -"shared/services/dialog.service" | papi-dts

    Namespace "shared/services/dialog.service"

    Index

    Variables

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

    Namespace "shared/services/dialog.service"

    Index

    Variables

    \ 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 b80cb4e9da..1c8026d1dd 100644 --- a/papi-dts/modules/_shared_services_dialog_service_model_.html +++ b/papi-dts/modules/_shared_services_dialog_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/dialog.service-model" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    Variables

    \ 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 a037f316b1..3e2b25259c 100644 --- a/papi-dts/modules/_shared_services_internet_service_.html +++ b/papi-dts/modules/_shared_services_internet_service_.html @@ -1,3 +1,3 @@ -"shared/services/internet.service" | papi-dts

    Namespace "shared/services/internet.service"

    Index

    Interfaces

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

    Namespace "shared/services/internet.service"

    Index

    Interfaces

    Variables

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

    Namespace "shared/services/localization.service"

    Index

    Variables

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

    Namespace "shared/services/localization.service"

    Index

    Variables

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

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    ILocalizationService LocalizationData LocalizationDataDataTypes LocalizationSelector diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index 67b9020c5d..2ad6c486d5 100644 --- a/papi-dts/modules/_shared_services_logger_service_.html +++ b/papi-dts/modules/_shared_services_logger_service_.html @@ -1,4 +1,4 @@ -"shared/services/logger.service" | papi-dts

    Namespace "shared/services/logger.service"

    Index

    Variables

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

    Namespace "shared/services/logger.service"

    Index

    Variables

    Functions

    \ 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 ffcecea769..7e753e8d84 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_.html @@ -1,2 +1,2 @@ -"shared/services/menu-data.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    \ 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 600e284b16..7704b19076 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 82c0839ece..3a6dc3f8e5 100644 --- a/papi-dts/modules/_shared_services_network_connector_factory_.html +++ b/papi-dts/modules/_shared_services_network_connector_factory_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.factory" | papi-dts

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

    Index

    Functions

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

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

    Index

    Functions

    \ 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 9b20954daa..2f3d30bf6d 100644 --- a/papi-dts/modules/_shared_services_network_connector_interface_.html +++ b/papi-dts/modules/_shared_services_network_connector_interface_.html @@ -1,2 +1,2 @@ -"shared/services/network-connector.interface" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    \ 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 fc39906ef0..39591795ff 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 8f86a2500a..7839d69779 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_.html @@ -1,2 +1,2 @@ -"shared/services/network-object-status.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    \ 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 4c9c42cf98..2e921872c2 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 10760cac9f..54ce3cbaf6 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 1bed6cef0d..09c41ff0e1 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-lookup.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    \ 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 d5abafc259..0fb0c92ca2 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-settings.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    \ 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 b7f938053b..9b991ed0dc 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-settings.service-model" | papi-dts

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

    Index

    Interfaces

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

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

    Index

    Interfaces

    Type Aliases

    AllProjectSettingsValidators ProjectSettingValidator SimultaneousProjectSettingsChanges diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index 42dccb8d01..e8f2b9fb64 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/settings.service" | papi-dts

    Namespace "shared/services/settings.service"

    Index

    Variables

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

    Namespace "shared/services/settings.service"

    Index

    Variables

    \ 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 613499e776..6bf75b5076 100644 --- a/papi-dts/modules/_shared_services_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service-model" | papi-dts

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

    Index

    Type Aliases

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

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

    Index

    Type Aliases

    AllSettingsData AllSettingsValidators ISettingsService SettingDataTypes diff --git a/papi-dts/modules/_shared_services_web_view_provider_service_.html b/papi-dts/modules/_shared_services_web_view_provider_service_.html index 0fb63d92ff..58982ebe34 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 fc025b7b4c..3a7d860633 100644 --- a/papi-dts/modules/_shared_services_web_view_service_.html +++ b/papi-dts/modules/_shared_services_web_view_service_.html @@ -1,2 +1,2 @@ -"shared/services/web-view.service" | papi-dts

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

    Index

    Variables

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

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

    Index

    Variables

    \ 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 5ab7e51b4f..17f978198e 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
    \ 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 5c3493af2d..9eb4476a7e 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 fe10a7838d..0c9a798a17 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 beaa467463..be758e3c5a 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts
    \ No newline at end of file +Papi | papi-dts
    \ 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 aac3123e93..52ce65d54e 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.

    -
    \ No newline at end of file +
    \ 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 fa14f50b91..45b56b3349 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

      -
    \ No newline at end of file +
    \ 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 3e799e0f74..aa1a16930c 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 @@ -22,4 +22,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.

    -
  • \ No newline at end of file +
    \ 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 23e7091397..41e78d6793 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
    ExecutionTokenType: "extension"

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

    -
    \ No newline at end of file +
    \ 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 7871e0d6aa..cef2fda54a 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
    DirectoryEntries: Readonly<{
        [entryType in EntryType]: Uri[]
    }>

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

    -
    \ No newline at end of file +
    \ 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 a71a50e10b..772a62d45b 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';
     
    -
    \ No newline at end of file +
    \ 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 da8f75a831..fa2b5c911c 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'
     
    -
    \ No newline at end of file +
    \ 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 82d9679d77..3b9fdf9df6 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>;
    }
    -
    \ No newline at end of file +
    \ 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 959b4a4932..2584351d1d 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.

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

    Returns Promise<UnsubscriberAsync>

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

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

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ 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 579d821b74..c04a747121 100644 --- a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html @@ -1,2 +1,2 @@ NotesOnlyProjectDataTypes | papi-dts

    Type alias NotesOnlyProjectDataTypes

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

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

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ 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 ebc8074c03..ec173c59c8 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts
    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    \ No newline at end of file +PlaceholderDataTypes | papi-dts
    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Type declaration

    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html index 03e25450a6..5db18fa664 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html @@ -7,4 +7,4 @@ PDP.

    Example

    ProjectInterfaceDataTypes['MyExtensionProjectInterfaceName'] => MandatoryProjectDataTypes & {
    MyProjectData: DataProviderDataType<string, string, string>;
    }
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html index 493239f3fa..9f041978f6 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html @@ -6,4 +6,4 @@ ProjectDataProviderInterfaces.

    Example

    'platform.notesOnly'
     
    -
    \ No newline at end of file +
    \ 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 e550024ea4..9ecc4a86ed 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'
     
    -
    \ No newline at end of file +
    \ 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 475e52dab2..44f5d95649 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'
     
    -
    \ No newline at end of file +
    \ 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 5bb044b3b1..a3dad18e3f 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts
    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    \ No newline at end of file +StuffDataTypes | papi-dts
    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Type declaration

    \ 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 ff3fa079d0..0c9460ae65 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -25,4 +25,4 @@

    Throws

    If the setting validator failed.

    See

    DataProviderUpdateInstructions for more info on what to return

    \ No newline at end of file +

    Returns Promise<DataProviderUpdateInstructions<TProjectDataTypes & MandatoryProjectDataTypes>>

    \ 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 b9b111edba..3386b54be4 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html @@ -14,4 +14,4 @@

    TODO: preserve requests between refreshes - save the dialog info in such a way that it works when loading again after refresh

  • Optional tabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -
  • \ No newline at end of file +
    \ 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 ce925ecc27..189b4c7c36 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

  • \ No newline at end of file +

    Returns void

    \ 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 a309f997ad..6456e6f9ad 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

    -
  • \ No newline at end of file +
    \ 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 de2d1f9f54..283621743a 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
    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    \ No newline at end of file +DialogDefinition | papi-dts
    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    \ 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 65db19caf5..09c6d7688d 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
    DialogTabTypes: keyof DialogTypes

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

    -
    \ No newline at end of file +
    \ 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 42b935e18e..c71522362a 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
    \ No newline at end of file +ProjectDialogOptionsBase | papi-dts
    \ No newline at end of file diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html index 3df8b60b45..16d86861b8 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html @@ -1,3 +1,3 @@ SelectBooksDialogOptions | papi-dts
    SelectBooksDialogOptions: DialogOptions & {
        selectedBookIds?: string[];
    }

    Options to provide when showing the Select Books dialog

    Type declaration

    • Optional selectedBookIds?: string[]

      Books IDs that should start selected in the dialog

      -
    \ No newline at end of file +
    \ 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 6f015d5a02..6f08dfb1b2 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
    SelectMultipleProjectsDialogOptions: ProjectDialogOptionsBase & {
        selectedProjectIds?: string[];
    }

    Options to provide when showing the Select Multiple Project dialog

    Type declaration

    • Optional selectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -
    \ No newline at end of file +
    \ 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 cf33a0a26b..48e52eae35 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
    SelectProjectDialogOptions: ProjectDialogOptionsBase

    Options to provide when showing the Select Project dialog

    -
    \ No newline at end of file +
    \ 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 b31b1e03e8..ad36e7cc17 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
    UseDialogCallbackOptions: {
        maximumOpenDialogs?: number;
    }

    Type declaration

    • Optional maximumOpenDialogs?: number

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

      -
    \ No newline at end of file +
    \ 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 2e624e6bda..92658df0eb 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

    -
    \ No newline at end of file +
    \ 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 04319cca49..2ae24fda87 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
    ClientConnectEvent: {
        clientId: number;
        didReconnect: boolean;
    }

    Event emitted when client connections are established

    -

    Type declaration

    • clientId: number
    • didReconnect: boolean
    \ No newline at end of file +

    Type declaration

    • clientId: number
    • didReconnect: boolean
    \ 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 0f04da358c..59d1282923 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
    ClientDisconnectEvent: {
        clientId: number;
    }

    Event emitted when client connections are lost

    -

    Type declaration

    • clientId: number
    \ No newline at end of file +

    Type declaration

    • clientId: number
    \ 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 7f00fc0867..6ecd820e4c 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
    InternalEvent<T>: {
        event: T;
        senderId: number;
    }

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • event: T

      Contents of the event

    • senderId: number

      The process that emitted this Event

      -
    \ No newline at end of file +
    \ 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 c2d76077db..56118252bf 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
    InternalNetworkEventHandler: (<T>(eventType, incomingEvent) => void)

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

    -

    Type declaration

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

        • T

        Parameters

        Returns void

    \ No newline at end of file +

    Type declaration

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

        • T

        Parameters

        Returns void

    \ 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 ebd97d5744..a5b36da232 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
    InternalRequest<TParam>: {
        requestId: number;
    } & ComplexRequest<TParam>

    Request to do something and to respond

    -

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number
    \ No newline at end of file +

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestId: number
    \ 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 73a5b52462..9da52798a2 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
    InternalRequestHandler: (<TParam, TReturn>(requestType, request) => Promise<InternalResponse<TReturn>>)

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

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ 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 d8f4a58cc1..9664a05cb2 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
    InternalResponse<TReturn>: {
        requestId: number;
        requesterId: number;
        senderId: number;
    } & ComplexResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestId: number
    • requesterId: number

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

    • senderId: number

      The process that sent this Response

      -
    \ No newline at end of file +
    \ 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 06cf6cfcca..5aa618ba7d 100644 --- a/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html +++ b/papi-dts/types/_shared_data_internal_connection_model_.NetworkConnectorEventHandlers.html @@ -2,4 +2,4 @@ from NetworkEventEmitters so the events inform all interested connections

    Type declaration

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

      Handles when a new connection is established

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

      Handles when a client disconnects

      -
    \ No newline at end of file +
    \ 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 6a6e281e84..a2ea722bb5 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
    NetworkConnectorInfo: Readonly<{
        clientId: number;
    }>

    Information about the network connector

    -

    Type declaration

    • clientId: number
    \ No newline at end of file +

    Type declaration

    • clientId: number
    \ 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 e69aa7970e..7ced16a4fb 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
    NetworkEventHandler: (<T>(eventType, event) => void)

    Handler for events from on the network

    -

    Type declaration

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

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    \ No newline at end of file +

    Type declaration

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

        • T

        Parameters

        • eventType: string
        • event: T

        Returns void

    \ 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 7e4121d9d3..bc7b0c3c63 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
    RequestHandler: (<TParam, TReturn>(requestType, request) => Promise<ComplexResponse<TReturn>>)

    Handler for requests from the server

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ 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 8869b11e9a..0914534981 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
    RequestRouter: ((requestType) => number)

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

    -

    Type declaration

      • (requestType): number
      • Parameters

        • requestType: string

        Returns number

    \ No newline at end of file +

    Type declaration

      • (requestType): number
      • Parameters

        • requestType: string

        Returns number

    \ 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 15ab377a1f..34286f588c 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
  • \ No newline at end of file +
  • senderId: number
  • type: ClientConnect
  • \ 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 d27150acd5..63e419c420 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
    InitClient: {
        clientGuid: string;
        connectorInfo: NetworkConnectorInfo;
        senderId: number;
        type: InitClient;
    }

    Message sent to the client to give it NetworkConnectorInfo

    Type declaration

    • clientGuid: string

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

      -
    • connectorInfo: NetworkConnectorInfo
    • senderId: number
    • type: InitClient
    \ No newline at end of file +
  • connectorInfo: NetworkConnectorInfo
  • senderId: number
  • type: InitClient
  • \ 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 74775a36d7..8b562b6162 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
    \ No newline at end of file +
    \ 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 b449d35cd9..1358eabbac 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
    WebSocketEvent<T>: {
        eventType: string;
        type: Event;
    } & InternalEvent<T>

    Event to be sent out throughout all processes

    Type Parameters

    • T

    Type declaration

    • eventType: string

      What kind of event this is

      -
    • type: Event
    \ No newline at end of file +
  • type: Event
  • \ 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 be9348b65e..a2c4f1c1b7 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
    WebSocketRequest<TParam>: {
        requestType: string;
        type: Request;
    } & InternalRequest<TParam>

    Request to do something and to respond

    Type Parameters

    • TParam = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Request
    \ No newline at end of file +
  • type: Request
  • \ 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 266e9945ae..6871411eae 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
    WebSocketResponse<TReturn>: {
        requestType: string;
        type: Response;
    } & InternalResponse<TReturn>

    Response to a request

    Type Parameters

    • TReturn = unknown

    Type declaration

    • requestType: string

      What kind of request this is. Certain command, etc

      -
    • type: Response
    \ No newline at end of file +
  • type: Response
  • \ No newline at end of file diff --git a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html index 5f44a11ad1..8de2764ace 100644 --- a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html @@ -27,4 +27,4 @@

    OR

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

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ 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 35ee2df870..92849189c0 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

    \ No newline at end of file +

    Type Parameters

    Type declaration

    \ 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 3bdd7510c5..0f2eb5a8c0 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.
  • -
    \ No newline at end of file +
    \ 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 16d4481ed1..0165578d84 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html @@ -23,4 +23,4 @@

    OR

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

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ 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 f1ff5eb953..970c06240e 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

    \ No newline at end of file +
    \ 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 0962ed585a..7b2a175304 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

    \ No newline at end of file +

    Type Parameters

    \ 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 182f590d5d..94b7ead386 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

    -
  • \ No newline at end of file +
    \ 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 79ad02b96c..c9c67cb77a 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>;
    }
    -
    \ No newline at end of file +
    \ 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 9868298ba9..b67b43e055 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

    -
    \ No newline at end of file +
    \ 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 4b948f27ed..c9cd503f94 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html @@ -1,3 +1,3 @@ DataProviderGetters | papi-dts

    Type alias DataProviderGetters<TDataTypes>

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

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

    Type Parameters

    See

    DataProviderGetter for more information

    -
    \ No newline at end of file +
    \ 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 a9afc09d04..d8d1ada929 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

    -
    \ No newline at end of file +
    \ 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 07697d9dd1..cc554d363a 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html @@ -1,3 +1,3 @@ DataProviderSetters | papi-dts

    Type alias DataProviderSetters<TDataTypes>

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

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

    Type Parameters

    See

    DataProviderSetter for more information

    -
    \ No newline at end of file +
    \ 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 e70e903763..648f7aa6a2 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

    -
    \ No newline at end of file +
    \ 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 e794906a38..401dcdcaae 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'
     
    -
    \ No newline at end of file +
    \ 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 1a7594912e..44c82f547f 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html @@ -1,4 +1,4 @@ DataProviderSubscribers | papi-dts

    Type alias DataProviderSubscribers<TDataTypes>

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

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

    Type Parameters

    See

    DataProviderSubscriber for more information

    -
    \ No newline at end of file +
    \ 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 360194dbf3..24a9056611 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

    \ No newline at end of file +

    Type Parameters

    \ 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 f615aef24d..2bb0991f14 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
    DataTypeNames<TDataTypes>: keyof TDataTypes & string

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

    Type Parameters

    See

    DataProviderDataTypes for more information

    -
    \ No newline at end of file +
    \ 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 b6e7ea2f8b..4303d51593 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

    -
    \ No newline at end of file +
    \ 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 4ad9d0da99..8d63473c4d 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
    DialogData: DialogOptions & {
        isDialog: true;
    }

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

    -

    Type declaration

    • isDialog: true
    \ No newline at end of file +

    Type declaration

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

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

    Default depends on the dialog

    -
  • \ No newline at end of file +
    \ 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 d83320d08c..5f12f25ac8 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

    \ No newline at end of file +

    Type declaration

    \ 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 66499a327c..790a8aee54 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
  • -
    \ No newline at end of file +
    \ 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 a538f9a2e2..1adac5abfe 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
    \ No newline at end of file +

    Type declaration

    • height: number
    • width: number
    \ 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 fc48844648..3d393413fa 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

    -
    \ No newline at end of file +
    \ 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 d5cb229a12..7293fdb92d 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>

    \ No newline at end of file +

    Type declaration

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

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

        Returns Promise<void>

    \ 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 0814298ff7..4d5c35f8fe 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"
    \ No newline at end of file +PanelDirection | papi-dts
    PanelDirection: "left" | "right" | "bottom" | "top" | "before-tab" | "after-tab" | "maximize" | "move" | "active" | "update"
    \ 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 ab9a779f79..900840ed49 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -27,4 +27,4 @@
      • (webViewId, updateInfo): boolean
      • Parameters

        • webViewId: string

          The ID of the WebView to update

        • updateInfo: WebViewDefinitionUpdateInfo

          Properties to update on the WebView. Any unspecified properties will stay the same

          -

        Returns boolean

    \ No newline at end of file +

    Returns boolean

    \ 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 68f9bd7686..bc7f49a8d3 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

    -
  • \ No newline at end of file +
    \ 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 015de3d030..a45169222b 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

    -
  • \ No newline at end of file +
    \ 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 8b81e542f3..49617944a8 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

    \ No newline at end of file +

    Type declaration

    \ 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 73d9ae8c71..d3aa1e84ad 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

    -
    \ No newline at end of file +
    \ 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 7b9488bdcd..c5b9adab86 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

    -
    \ No newline at end of file +
    \ 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 2b65552323..e43535403a 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

    \ No newline at end of file +

    Type Parameters

    \ 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 a483165f09..8b49a6d805 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

    -
    \ No newline at end of file +
    \ 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 e0896936be..55b8fe1ea4 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

    -
    \ No newline at end of file +
    \ 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 000b53be4f..88cc2b9a90 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

    -
    \ No newline at end of file +
    \ 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 b7c1897898..6063d04875 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.

    -
    \ No newline at end of file +
    \ 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 9d01411076..81346ce9b2 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

    -
    \ No newline at end of file +
    \ 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 6e0693f035..44b94f1b36 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html @@ -26,4 +26,4 @@

    OR

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

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html index 81b2c83f98..6937997c6a 100644 --- a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html @@ -1,3 +1,3 @@ ProjectMetadataFilterOptions | papi-dts
    ProjectMetadataFilterOptions: ModifierProject & {
        excludeProjectIds?: string | string[];
        includeProjectIds?: string | string[];
    }

    Type declaration

    • Optional excludeProjectIds?: string | string[]

      Project IDs to exclude

    • Optional includeProjectIds?: string | string[]

      Project IDs to include

      -
    \ No newline at end of file +
    \ 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 1ff9beeb8e..824ada113c 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

    -
  • \ No newline at end of file +
    \ 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 51fe32a152..22b8d34a1e 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html @@ -49,4 +49,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ 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 46b0df8d23..afd050fd46 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
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html index 1919c20fe4..df60b63ce3 100644 --- a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html @@ -8,8 +8,8 @@ https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator:

    Only strings that differ in base letters or accents and other diacritic marks compare as unequal. Examples: a ≠ b, a ≠ á, a = A.

    -

    Parameters

    • projectIdA: string
    • projectIdB: string

    Returns boolean

  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function
    • Provide metadata for all projects that have PDP factories

      +

      Parameters

      • projectIdA: string
      • projectIdB: string

      Returns boolean

  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function
    • Provide metadata for all projects that have PDP factories

      Note: If there are multiple PDPs available whose metadata matches the conditions provided by the parameters, their project metadata will all be combined, so all available projectInterfaces provided by the PDP Factory with the matching id (or all PDP Factories if @@ -20,7 +20,7 @@ As a result, a PDP factory that intends to layer over other PDP factories must specify its id in options.excludePdpFactoryIds to avoid an infinite loop of calling this function.

    Returns Promise<ProjectMetadata[]>

    ProjectMetadata for all projects stored on the local system

    -
  • getMetadataForProject:function
  • getMetadataForProject:function
    • Look up metadata for a specific project ID

      Note: If there are multiple PDPs available whose metadata matches the conditions provided by the parameters, their project metadata will all be combined, so all available projectInterfaces provided by the PDP Factory with the matching id (or all PDP Factories if @@ -32,7 +32,7 @@

    • Optional pdpFactoryId: string

      Optional ID of the PDP factory where the project ID should be loaded. If not provided, then look in all available PDP factories for the given project ID.

    Returns Promise<ProjectMetadata>

    ProjectMetadata for the given project

    -
  • getMinimalMatchPdpFactoryId:function
    • Get the PDP Factory info whose projectInterfaces are most minimally matching to the provided +

  • getMinimalMatchPdpFactoryId:function
    • Get the PDP Factory info whose projectInterfaces are most minimally matching to the provided projectInterface

      Hopefully this will allow us to get the PDP that most closely matches the projectInterfaces to avoid unnecessary redirects through layered PDPs

      @@ -41,5 +41,5 @@

    Returns undefined | string

    PDP Factory id whose projectInterfaces minimally match the provided projectInterface if at least one PDP Factory was found that supports the projectInterface provided

    -
  • mergeMetadataFilters:function
  • \ No newline at end of file +
  • mergeMetadataFilters:function
  • \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html index bdde412c00..ad4ea90e06 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html @@ -1,4 +1,4 @@ ProjectDataProviderFactoryMetadataInfo | papi-dts
    ProjectDataProviderFactoryMetadataInfo: {
        projectInterfaces: ProjectInterfaces[];
    }

    Type declaration

    • projectInterfaces: ProjectInterfaces[]

      Which projectInterfaces (aka standardized sets of methods on a PDP) the Project Data Provider for this project created by this Project Data Provider Factory supports. Indicates what sort of project data should be available on this project from this PDP Factory.

      -
    \ No newline at end of file +
    \ 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 85a0f15a9f..6779ecec27 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -12,4 +12,4 @@

    The keys of this object are ids of the PDP Factories that provide the metadata, namely the projectInterfaces for this project (meaning this PDPF can provide a Project Data Provider for this project with these projectInterfaces)

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html index 29363d85ba..458080ab47 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html @@ -6,4 +6,4 @@
  • projectInterfaces: ProjectInterfaces[]

    All projectInterfaces (aka standardized sets of methods on a PDP) that Project Data Providers for this project support. Indicates what sort of project data should be available on this project.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html index ef5830c9ef..31e819561b 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html @@ -1,4 +1,4 @@ GetSavedWebViewDefinition | papi-dts
    GetSavedWebViewDefinition: (() => SavedWebViewDefinition | undefined)

    Gets the saved properties on this WebView's WebView definition

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

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ 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 8c24091680..1a24045bc9 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

    -
    \ No newline at end of file +
    \ 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 c9a7a27c44..ad24fb8116 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

    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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html index 077b45079d..133efb3d28 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html @@ -1,3 +1,3 @@ SavedWebViewDefinitionOmittedKeys | papi-dts
    SavedWebViewDefinitionOmittedKeys: typeof SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS[number]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -
    \ No newline at end of file +
    \ 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 4a12cbb617..273040d086 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -6,4 +6,4 @@

    @example

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

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ 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 429a49e4cc..dfb62845c4 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -24,4 +24,4 @@

    @example

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

    Type declaration

      • <T>(stateKey, defaultStateValue): [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]
      • Type Parameters

        • T

        Parameters

        • stateKey: string
        • defaultStateValue: T

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

    \ No newline at end of file +

    Type declaration

      • <T>(stateKey, defaultStateValue): [webViewStateValue: T, setWebViewState: ((stateValue) => void), resetWebViewState: (() => void)]
      • Type Parameters

        • T

        Parameters

        • stateKey: string
        • defaultStateValue: T

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

    \ 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 beca938f14..c6e4bd023f 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

    -
    \ No newline at end of file +
    \ 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 b690d953e1..c8d7b1ce57 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -70,4 +70,4 @@
  • Optional title?: string

    Name of the tab for the WebView

  • Optional tooltip?: string

    Tooltip that is shown when hovering over the webview title

  • webViewType: WebViewType

    What type of WebView this is. Unique to all other WebView definitions

    -
  • \ No newline at end of file +
    \ 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 dd3f2aa0d0..4191a02695 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

      -
    \ No newline at end of file +
    \ 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 28c19d724b..7aecece492 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

      -
    \ No newline at end of file +
    \ 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 dba9025fa4..572620eace 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

      -
    \ No newline at end of file +
    \ 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 b3c7d66616..63ce2f8c28 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, typeof WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS[number]>

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

    -
    \ No newline at end of file +
    \ 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 59a03cb539..c44e628457 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

    -
    \ No newline at end of file +
    \ 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 9618fcdeed..5d94cb9a3f 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

    -
    \ No newline at end of file +
    \ 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 41f7a62433..4ab7ed1b5f 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -33,4 +33,4 @@

    @example

    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -
    \ No newline at end of file +
    \ 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 a431f87895..de5b874c7c 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.

    -
    \ No newline at end of file +
    \ 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 f1b7104818..b12b9ee659 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

      \ No newline at end of file +

      Type declaration

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html index a7826451b5..4ea47c329c 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html +++ b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html @@ -9,8 +9,8 @@ string key that corresponds to a localized value and an array of BCP 47 language codes

        Returns Promise<LocalizationData>

      • setLocalizedString:function
      • setLocalizedStrings:function
      • setLocalizedStrings:function
      • Type declaration

        • getLocalizedIdFromBookNumber:function
          • This function is used to take a book number from a verse ref and return the localized name of +

        Type declaration

        • getLocalizedIdFromBookNumber:function
          • This function is used to take a book number from a verse ref and return the localized name of the book so that the book name can be displayed in the UI language within the UI

            -

            Parameters

            • bookNum: number
            • localizationLanguage: string

            Returns Promise<string>

        \ No newline at end of file +

        Parameters

        • bookNum: number
        • localizationLanguage: string

        Returns Promise<string>

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html index 0058a1dee9..72a82b1879 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html @@ -1 +1 @@ -LocalizationData | papi-dts
        LocalizationData: LanguageStrings
        \ No newline at end of file +LocalizationData | papi-dts
        LocalizationData: LanguageStrings
        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html index f97d8b7dc5..ca6879d496 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html @@ -1 +1 @@ -LocalizationDataDataTypes | papi-dts
        LocalizationDataDataTypes: {
            LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
            LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
        }

        Type declaration

        \ No newline at end of file +LocalizationDataDataTypes | papi-dts
        LocalizationDataDataTypes: {
            LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
            LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
        }

        Type declaration

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html index 082d1ff5a1..60086f3b43 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html @@ -1 +1 @@ -LocalizationSelector | papi-dts
        LocalizationSelector: {
            locales?: string[];
            localizeKey: LocalizeKey;
        }

        Type declaration

        • Optional locales?: string[]
        • localizeKey: LocalizeKey
        \ No newline at end of file +LocalizationSelector | papi-dts
        LocalizationSelector: {
            locales?: string[];
            localizeKey: LocalizeKey;
        }

        Type declaration

        • Optional locales?: string[]
        • localizeKey: LocalizeKey
        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html index 8ae21d3da7..7b00081d78 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html @@ -1 +1 @@ -LocalizationSelectors | papi-dts
        LocalizationSelectors: {
            locales?: string[];
            localizeKeys: LocalizeKey[];
        }

        Type declaration

        • Optional locales?: string[]
        • localizeKeys: LocalizeKey[]
        \ No newline at end of file +LocalizationSelectors | papi-dts
        LocalizationSelectors: {
            locales?: string[];
            localizeKeys: LocalizeKey[];
        }

        Type declaration

        • Optional locales?: string[]
        • localizeKeys: LocalizeKey[]
        \ 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 9e6a1cd2f6..28c0deff79 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html @@ -2,21 +2,21 @@

        Type declaration

        • getMainMenu:function
          • Get menu content for the main menu

            Parameters

            • mainMenuType: undefined

              Does not have to be defined

            Returns Promise<MultiColumnMenu>

            MultiColumnMenu object of main menu content

            -
          • Get menu content for the main menu

            +
          • Get menu content for the main menu

            Returns Promise<MultiColumnMenu>

            MultiColumnMenu object of main menu content

            -
        • getWebViewMenu:function
        • getWebViewMenu:function
          • Get menu content for a web view

            Parameters

            • webViewType: `${string}.${string}`

              The type of webview for which a menu should be retrieved

            Returns Promise<WebViewMenu>

            WebViewMenu object of web view menu content

            -
        • rebuildMenus:function
          • Rebuild the menus with the latest inputs from all extensions.

            -

            Returns Promise<void>

        • setMainMenu:function
        • rebuildMenus:function
          • Rebuild the menus with the latest inputs from all extensions.

            +

            Returns Promise<void>

        • setMainMenu:function
        • setWebViewMenu:function
        • setWebViewMenu:function
        • subscribeMainMenu:function
          • Subscribe to run a callback function when the main menu data is changed

            +
        • subscribeMainMenu:function
          • Subscribe to run a callback function when the main menu data is changed

            Parameters

            • mainMenuType: undefined

              Does not have to be defined

            • callback: ((menuContent) => void)

              Function to run with the updated menuContent for this selector

                • (menuContent): void
                • Parameters

                  • menuContent: {
                        columns: ColumnsWithHeaders;
                        groups: GroupsInMultiColumnMenu;
                        items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
                    }
                    • columns: ColumnsWithHeaders

                      Columns that belong in this menu

                      @@ -24,7 +24,7 @@
                    • items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[]

                      List of menu items that belong in this menu

                  Returns void

            • Optional options: DataProviderSubscriberOptions

              Various options to adjust how the subscriber emits updates

            Returns Promise<UnsubscriberAsync>

            Unsubscriber function (run to unsubscribe from listening for updates)

            -
        • subscribeWebViewMenu:function
          • Subscribe to run a callback function when the web view menu data is changed

            +
        • subscribeWebViewMenu:function
          • Subscribe to run a callback function when the web view menu data is changed

            Parameters

            • webViewType: `${string}.${string}`

              The type of webview for which a menu should be subscribed

            • callback: ((menuContent) => void)

              Function to run with the updated menuContent for this selector

                • (menuContent): void
                • Parameters

                  • menuContent: {
                        contextMenu: SingleColumnMenu | undefined;
                        includeDefaults: boolean | undefined;
                        topMenu: MultiColumnMenu | undefined;
                    }
                    • contextMenu: SingleColumnMenu | undefined

                      Menu that opens when you right click on the main body/area of a tab

                      @@ -32,4 +32,4 @@
                    • topMenu: MultiColumnMenu | undefined

                      Menu that opens when you click on the top left corner of a tab

                  Returns void

            • Optional options: DataProviderSubscriberOptions

              Various options to adjust how the subscriber emits updates

            Returns Promise<UnsubscriberAsync>

            Unsubscriber function (run to unsubscribe from listening for updates)

            -
        \ No newline at end of file +
        \ 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 bffccc22cb..898e5f7e9c 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html @@ -1 +1 @@ -MenuDataDataTypes | papi-dts
        MenuDataDataTypes: {
            MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
            WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
        }

        Type declaration

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

        Type declaration

        \ 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 022fa51033..cba14db6f1 100644 --- a/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ArgsRequestHandler.html @@ -2,4 +2,4 @@ the spread of the contents array of the request as its parameters. The function should return an object that becomes the contents object of the response. This type of handler is a normal function.

        -

        Type Parameters

        • TParam extends unknown[] = any[]
        • TReturn = any

        Type declaration

        \ No newline at end of file +

        Type Parameters

        • TParam extends unknown[] = any[]
        • TReturn = any

        Type declaration

        \ 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 7b69bad5fc..c9b21c9718 100644 --- a/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html +++ b/papi-dts/types/_shared_services_network_service_.ComplexRequestHandler.html @@ -2,4 +2,4 @@ accept a ComplexRequest object as its single parameter. The function should return a ComplexResponse object that becomes the response.. This type of handler is the most flexible of the request handlers.

        -

        Type Parameters

        • TParam = any
        • TReturn = any

        Type declaration

        \ No newline at end of file +

        Type Parameters

        • TParam = any
        • TReturn = any

        Type declaration

        \ 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 6800612202..2b6b48cc92 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

        \ No newline at end of file +

        Type Parameters

        • TParam = any
        • TReturn = any

        Type declaration

        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html index 47006565a6..df67d21bf3 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html @@ -1,3 +1,3 @@ AllProjectSettingsValidators | papi-dts
        AllProjectSettingsValidators: {
            [ProjectSettingName in ProjectSettingNames]: ProjectSettingValidator<ProjectSettingName>
        }

        Validators for all project settings. Keys are setting keys, values are functions to validate new settings

        -
        \ No newline at end of file +
        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html index e027739171..3f589ff6a0 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html @@ -2,4 +2,4 @@

        Type Parameters

        Type declaration

        \ No newline at end of file +

        Returns Promise<boolean>

        \ 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 48c6d4f1ba..1f897c3c96 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

        -
        \ No newline at end of file +
        \ 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 475a69dfab..9399e99595 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]
        }
        \ No newline at end of file +AllSettingsData | papi-dts
        AllSettingsData: {
            [SettingName in SettingNames]: SettingTypes[SettingName]
        }
        \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html index 07873c7481..18f1b7c46a 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html @@ -1,2 +1,2 @@ AllSettingsValidators | papi-dts
        AllSettingsValidators: {
            [SettingName in SettingNames]: SettingValidator<SettingName>
        }

        Validators for all settings. Keys are setting keys, values are functions to validate new settings

        -
        \ No newline at end of file +
        \ 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 27d7d9ebbe..76d33ed3bb 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html +++ b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html @@ -3,23 +3,23 @@

        Returns Promise<SettingTypes[SettingName]>

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

        Throws

        If no default value is available for the setting.

        -
      • registerValidator:function
        • Registers a function that validates whether a new setting value is allowed to be set.

          +
      • registerValidator:function
        • Registers a function that validates whether a new setting value is allowed to be set.

          Type Parameters

          Parameters

          Returns Promise<UnsubscriberAsync>

          Unsubscriber that should be called whenever the providing extension is deactivated

          -
      • reset:function
      • reset:function
        • Removes the setting from memory and resets it to its default value

          Type Parameters

          Parameters

          • key: SettingName

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

          Returns Promise<boolean>

          true if successfully reset the project setting. false otherwise

          -
      • set:function
      • set:function
      • subscribe:function
        • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the +

      • subscribe:function
        • Subscribes to updates of the specified setting. Whenever the value of the setting changes, the callback function is executed.

          Type Parameters

          Parameters

          • key: SettingName

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

          • callback: ((newSetting) => void)

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

          • Optional options: DataProviderSubscriberOptions

            Various options to adjust how the subscriber emits updates

          Returns Promise<UnsubscriberAsync>

          Unsubscriber that should be called whenever the subscription should be deleted

          -
      • \ No newline at end of file +
        \ 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 c07a2f1de7..cc659b8e89 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

          \ No newline at end of file +

          Type declaration

            \ No newline at end of file diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html index d8fbb07193..acc067bc45 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html @@ -1,2 +1,2 @@ SettingValidator | papi-dts
            SettingValidator<SettingName>: ((newValue, currentValue, allChanges) => Promise<boolean>)

            Function that validates whether a new setting value should be allowed to be set

            -

            Type Parameters

            Type declaration

            \ No newline at end of file +

            Type Parameters

            Type declaration

            \ 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 7c1df92807..87fd16483b 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

              -
            \ No newline at end of file +
            \ 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 bb88b7d3c8..c9a3bfdb3d 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
            \ No newline at end of file +

            Type Parameters

            • TReturn = unknown
            \ 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 16f2f4855c..a9d0aefce4 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

              -
            \ No newline at end of file +
            \ 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 47732f5a86..eff465b79f 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

              -
            \ No newline at end of file +
            \ 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 d0029f1bc8..b01ee41b76 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

              -
            \ No newline at end of file +
            \ 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 9d3d470b58..98d6f3a3c8 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

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html index 1d4482bd0b..c6a2a2bc24 100644 --- a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html @@ -6,4 +6,4 @@
            this.notifyUpdate('Setting');
             

            See

            IBaseProjectDataProviderEngine for more information on extending this class.

            -
            \ No newline at end of file +
            \ 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 2db5b0d0fd..116696d510 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.

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html index 52e4f4bf0d..cc3e7159f3 100644 --- a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html @@ -5,4 +5,4 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

            -
            \ No newline at end of file +
            \ 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 52a70285f8..18f102b9dc 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -6,4 +6,4 @@
            this.notifyUpdate('Setting');
             

            See

            IProjectDataProviderEngine for more information on extending this class.

            -
            \ No newline at end of file +
            \ 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 037e3d888a..06297e726f 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.

            -
            \ No newline at end of file +
            \ 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 28b86bac3a..61ff2e9fd2 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

            -
            \ No newline at end of file +
            \ 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 afe625aa9b..56098ec2b4 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -49,4 +49,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.

            -
          • \ No newline at end of file +
            \ 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 5a07c30f01..9bcf3804a6 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

            -
            \ No newline at end of file +
            \ 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 3d4713f2f8..610bbeb44c 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

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.localization.html b/papi-dts/variables/__papi_backend_.localization.html index 88ec6e7c40..c99f01ac92 100644 --- a/papi-dts/variables/__papi_backend_.localization.html +++ b/papi-dts/variables/__papi_backend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

            Variable localizationConst

            localization: ILocalizationService

            Service that allows to get and store localizations

            -
            \ No newline at end of file +
            \ 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 e56ade1eb5..aec666a0df 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
            \ No newline at end of file +

            Type declaration

            • default: MainLogger
            \ 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 d74755be38..94e03a065f 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

            -
            \ No newline at end of file +
            \ 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 2aac8c52c8..baa8d0982e 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

            -
            \ No newline at end of file +
            \ 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 0cb95ac02a..f8d4022cc9 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

            -
            \ No newline at end of file +
            \ 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 f5dcd07948..017f8788b7 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -2,4 +2,4 @@

            Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

            -
            \ No newline at end of file +
            \ 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 b1d43a826b..43196c43cc 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,2 +1,2 @@ projectSettings | papi-dts

            Variable projectSettingsConst

            projectSettings: IProjectSettingsService

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

            -
            \ No newline at end of file +
            \ No newline at end of file diff --git a/papi-dts/variables/__papi_backend_.settings.html b/papi-dts/variables/__papi_backend_.settings.html index e94ac0095a..93ae8edfbf 100644 --- a/papi-dts/variables/__papi_backend_.settings.html +++ b/papi-dts/variables/__papi_backend_.settings.html @@ -1 +1 @@ -settings | papi-dts
            \ No newline at end of file +settings | papi-dts
            \ 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 711c9bff28..7edc1b66f8 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.

            -
            \ No newline at end of file +
            \ 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 0e2efe8c99..b2628e550a 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

            -
            \ No newline at end of file +
            \ 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 c59fcfc028..f590b3adba 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.

            -
            \ No newline at end of file +
            \ 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 4fef1c62f0..290704ad2e 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

              \ No newline at end of file +

              Type declaration

                \ 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 3a30c5d791..9fcb7fb687 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.

                -
                \ No newline at end of file +
                \ 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 3163aaeb6e..e8e6f474e2 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.

                -
                \ No newline at end of file +
                \ 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 cc9ed4edab..d3d5087148 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.

                -
                \ No newline at end of file +
                \ 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 92db8b38f7..12d50a404c 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

                -
                \ No newline at end of file +
                \ 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 a81283f5aa..9468ef35a5 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -26,4 +26,4 @@
              • settings: ISettingsService
              • webViews: WebViewServiceType

                Service exposing various functions related to using webViews

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

                -
              • \ No newline at end of file +
                \ 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 fbb7c4ffcf..f8c7b526b3 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

                -
                \ No newline at end of file +
                \ 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 91bb6e8c26..d49d9aa3cd 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/__papi_frontend_.localization.html b/papi-dts/variables/__papi_frontend_.localization.html index c94d8a36c2..39553b8dc0 100644 --- a/papi-dts/variables/__papi_frontend_.localization.html +++ b/papi-dts/variables/__papi_frontend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

                Variable localizationConst

                localization: ILocalizationService

                Service that allows to get and store localizations

                -
                \ No newline at end of file +
                \ 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 3786d6b039..1cd3cb69a7 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
                \ No newline at end of file +

                Type declaration

                • default: MainLogger
                \ 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 6831893f99..69ba5c2e69 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

                -
                \ No newline at end of file +
                \ 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 f9168ac0f0..7652676d84 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

                -
                \ No newline at end of file +
                \ 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 5a50bf3a9f..5edc6d89fa 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

                -
                \ No newline at end of file +
                \ 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 9ea133eab0..1e0b2decb8 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -2,4 +2,4 @@

                Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

                -
                \ No newline at end of file +
                \ 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 d7dd51b7b2..fab971560f 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.

                -
                \ No newline at end of file +
                \ 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 764f8d4ea7..b5e2eec96a 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts
                \ No newline at end of file +settings | papi-dts
                \ 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 62f6e93579..8f6b1d5e05 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.

                -
                \ No newline at end of file +
                \ 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 1593f3a9aa..655ec2ff16 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.

                -
                \ No newline at end of file +
                \ 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 b8962b6475..d6c95a428b 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
                \ 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
                \ 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 f5b32a93d6..7f00cddf94 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://'
                \ No newline at end of file +FILE_PROTOCOL | papi-dts

                Variable FILE_PROTOCOLConst

                FILE_PROTOCOL: "file://" = 'file://'
                \ 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 6e6b2a2ac6..6cd6485c1c 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://'
                \ No newline at end of file +RESOURCES_PROTOCOL | papi-dts

                Variable RESOURCES_PROTOCOLConst

                RESOURCES_PROTOCOL: "resources://" = 'resources://'
                \ 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 3417ae8262..ca6a5269e0 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 }

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html index dee48a95f5..60e24c88e6 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_BOOKS_DIALOG_TYPE | papi-dts
                SELECT_BOOKS_DIALOG_TYPE: "platform.selectBooks" = 'platform.selectBooks'

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

                -
                \ No newline at end of file +
                \ 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 5f670d0a62..8fa6f049c0 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

                -
                \ No newline at end of file +
                \ 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 c319a020b1..fcca6a690b 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

                -
                \ No newline at end of file +
                \ 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 77557b8762..ba3a9e3b49 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

                -
                \ No newline at end of file +
                \ 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 d5951c3d4d..b592822c83 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

                -
                \ No newline at end of file +
                \ 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 0f193f9bd6..69373e41a0 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html index 405bb03737..4e088edfc3 100644 --- a/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html +++ b/papi-dts/variables/_shared_data_internal_connection_model_.CLIENT_ID_UNKNOWN.html @@ -1,4 +1,4 @@ CLIENT_ID_UNKNOWN | papi-dts
                CLIENT_ID_UNKNOWN: -2 = -2

                Represents when the request router does not know to which client id the request belongs. Server should try to determine the correct client id through other means, and client should just send to server

                -
                \ No newline at end of file +
                \ 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 70388dbb2c..4a3b5af282 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
                \ No newline at end of file +

                Type declaration

                • clientId: -1
                \ 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 c679dac3cd..f68e346ed4 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

                -
                \ No newline at end of file +
                \ 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 d0d2a00b66..042cec5f38 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

                -
                \ No newline at end of file +
                \ 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 5826f63d4b..486f77e58b 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html index 95d5282e7b..1aab4eeb45 100644 --- a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html @@ -1,2 +1,2 @@ DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS | papi-dts
                DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS: readonly ["title", "prompt"]

                Keys of properties on DialogOptions that should be localized if they are LocalizeKeys

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index ca72ca1d63..a9c7423e4a 100644 --- a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts
                networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'
                \ No newline at end of file +networkObjectStatusServiceNetworkObjectName | papi-dts
                networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html index c9d177578e..0b6835743d 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html @@ -1 +1 @@ -PDP_FACTORY_OBJECT_TYPE | papi-dts
                PDP_FACTORY_OBJECT_TYPE: string
                \ No newline at end of file +PDP_FACTORY_OBJECT_TYPE | papi-dts
                PDP_FACTORY_OBJECT_TYPE: string
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html index 91ca305e4f..021b953967 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html @@ -1,3 +1,3 @@ PROJECT_INTERFACE_PLATFORM_BASE | papi-dts
                PROJECT_INTERFACE_PLATFORM_BASE: "platform.base" = 'platform.base'

                The name of the projectInterface representing the essential methods every Base Project Data Provider must implement

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html index 3f9df697cf..6b3205dc84 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts
                NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'
                \ No newline at end of file +NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts
                NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html index 732d4bea39..ee10a435ed 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html @@ -1,2 +1,2 @@ projectLookupServiceBase | papi-dts
                projectLookupServiceBase: ProjectLookupServiceType

                Local object of functions to run locally on each process as part of the project lookup service

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html index 7f95243b82..4d10e51c1c 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html @@ -1,2 +1,2 @@ testingProjectLookupService | papi-dts
                testingProjectLookupService: {
                    compareProjectDataProviderFactoryMetadataInfoMinimalMatch: typeof compareProjectDataProviderFactoryMetadataInfoMinimalMatch;
                    internalGetMetadata: typeof internalGetMetadata;
                    transformGetMetadataForProjectParametersToFilter: typeof transformGetMetadataForProjectParametersToFilter;
                }

                This is an internal-only export for testing purposes and should not be used in development

                -

                Type declaration

                \ No newline at end of file +

                Type declaration

                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html index eb37f98c9f..825e222952 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html @@ -1,3 +1,3 @@ SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS | papi-dts

                Variable SAVED_WEBVIEW_DEFINITION_OMITTED_KEYSConst

                SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS: readonly ["content", "styles", "allowScripts", "allowSameOrigin", "allowedFrameSources"]

                The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html index 513f22cbc0..2c364f1b13 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html @@ -1,3 +1,3 @@ WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS | papi-dts

                Variable WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYSConst

                WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS: readonly ["iconUrl", "title", "tooltip", "projectId"]

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

                -
                \ No newline at end of file +
                \ 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 829ac29456..d29488410a 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

                -
                \ No newline at end of file +
                \ 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 b59642a6b5..ea171d8243 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
                \ No newline at end of file +default | papi-dts
                \ 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 1c39e0cbb7..1fee2e99fd 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

                -
                \ No newline at end of file +
                \ 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 10ea1bd122..c6b25ef69f 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_.default.html b/papi-dts/variables/_shared_services_localization_service_.default.html index dcf9dbb145..f78c7d9371 100644 --- a/papi-dts/variables/_shared_services_localization_service_.default.html +++ b/papi-dts/variables/_shared_services_localization_service_.default.html @@ -1 +1 @@ -default | papi-dts
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html index 57080923a3..e19f9d1a59 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html @@ -1,3 +1,3 @@ localizationServiceObjectToProxy | papi-dts
                localizationServiceObjectToProxy: Readonly<{
                    dataProviderName: "platform.localizationDataServiceDataProvider";
                }>

                Type declaration

                • dataProviderName: "platform.localizationDataServiceDataProvider"

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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html index cbf7d476bf..6c8165d1b7 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html @@ -1,3 +1,3 @@ localizationServiceProviderName | papi-dts
                localizationServiceProviderName: "platform.localizationDataServiceDataProvider" = 'platform.localizationDataServiceDataProvider'

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

                -
                \ No newline at end of file +
                \ 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 ea40cd2a3d..6ddcaf83c4 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>'
                \ No newline at end of file +WARN_TAG | papi-dts
                WARN_TAG: "<WARN>" = '<WARN>'
                \ 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 59ddcbdcec..fae583a438 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
                \ No newline at end of file +

                Type declaration

                • default: log.MainLogger
                \ 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 92716a2166..b58cb9b207 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
                \ No newline at end of file +default | papi-dts
                \ 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 af22d0821c..e756729a13 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

                  -
                \ No newline at end of file +
                \ 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 e208a93390..d9cc0eed6d 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

                -
                \ No newline at end of file +
                \ 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 11d91b0e3b..a69ece955d 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.

                -
                \ No newline at end of file +
                \ 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 0d4cb27258..358c807e50 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
                \ No newline at end of file +default | papi-dts
                \ 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 7c7c32614e..6705ae7b91 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

                -
                \ No newline at end of file +
                \ 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 b16385b294..853b7c4645 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

                -
                \ No newline at end of file +
                \ 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 cf6286eb97..1f55736e5b 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
                \ No newline at end of file +

                Type declaration

                • get: typeof get
                \ 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 9fe0088cf2..9b0c153db9 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
                \ No newline at end of file +default | papi-dts
                \ 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 8f1e7f7d4a..fa3d8589ab 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html index 03af7929cd..4fef2f4828 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR | papi-dts
                CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR: "extensionProjectSettingValidator" = 'extensionProjectSettingValidator'

                Name prefix for registered commands that call project settings validators

                -
                \ No newline at end of file +
                \ 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 15ea438b14..fe89251da5 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'
                \ No newline at end of file +projectSettingsServiceNetworkObjectName | papi-dts
                projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html index fc0d0f16c8..8e1bea9613 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html @@ -2,4 +2,4 @@

                Returns

                Unsubscriber that should be called whenever the providing extension is deactivated

                \ No newline at end of file +

                Returns Promise<UnsubscriberAsync>

                \ 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 eada6d1f55..439b500224 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
                \ No newline at end of file +default | papi-dts
                \ No newline at end of file diff --git a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html index b87c9b89c0..0a6caba688 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_SETTING_VALIDATOR | papi-dts
                CATEGORY_EXTENSION_SETTING_VALIDATOR: "extensionSettingValidator" = 'extensionSettingValidator'

                Name prefix for registered commands that call settings validators

                -
                \ No newline at end of file +
                \ 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 0a0b5d5523..21732deb40 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

                -
                \ No newline at end of file +
                \ 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 d5386cc007..3cac19e726 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html @@ -4,4 +4,4 @@

                Returns

                Unsubscriber that should be called whenever the providing extension is deactivated

                \ No newline at end of file +

                Returns Promise<UnsubscriberAsync>

                \ 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 e1276d64e8..f3e001cc2f 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
                \ No newline at end of file +default | papi-dts
                \ 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 933633cfd1..5296faa04c 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

                -
                \ No newline at end of file +
                \ 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 7604d0b020..9d45cb4132 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
                \ No newline at end of file +default | papi-dts
                \ 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 d462d70d44..a496e4c1f5 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

                -
                \ No newline at end of file +
                \ 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 5c9cac8324..b450f5c72c 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'
                \ No newline at end of file +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
                NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'
                \ 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 108c74777c..51d2ae638b 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
                \ No newline at end of file +

                Type declaration

                • [moduleName: string]: string | {
                      [process in ProcessType | "default"]?: string
                  } | undefined
                \ 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 70d6c67cdc..aa8f7bbffd 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/isNoisyDevModeEnabled.html b/papi-dts/variables/isNoisyDevModeEnabled.html index 7f97f8c486..d221f75837 100644 --- a/papi-dts/variables/isNoisyDevModeEnabled.html +++ b/papi-dts/variables/isNoisyDevModeEnabled.html @@ -1,2 +1,2 @@ isNoisyDevModeEnabled | papi-dts

                Variable isNoisyDevModeEnabled

                isNoisyDevModeEnabled: boolean

                Indicates whether test code meant just for developers to see should be run

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 51d41d1da3..80791573bf 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 833ead5498..4745af03ed 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 05a47f4ded..0796b9f1c3 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index 6887f5d710..e2e1d83a9b 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/enums/LabelPosition.html b/platform-bible-react/enums/LabelPosition.html index 71d762d7a1..2e6202c81b 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
                \ No newline at end of file +

                Enumeration Members

                Above: "above"
                After: "after"
                Before: "before"
                Below: "below"
                \ No newline at end of file diff --git a/platform-bible-react/functions/BookChapterControl.html b/platform-bible-react/functions/BookChapterControl.html index 81c18c6573..884617915e 100644 --- a/platform-bible-react/functions/BookChapterControl.html +++ b/platform-bible-react/functions/BookChapterControl.html @@ -1 +1 @@ -BookChapterControl | platform-bible-react

                Function BookChapterControl

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

                Function BookChapterControl

                \ No newline at end of file diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index 3a3a037a17..be96811a41 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ -Button | platform-bible-react

                Properties

                $$typeof +Button | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index abab768bb0..8e14a4221d 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

                Function ChapterRangeSelector

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

                Function ChapterRangeSelector

                \ No newline at end of file diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index f528cb9fcd..a454594bf4 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,2 +1,2 @@ Checkbox | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Checklist.html b/platform-bible-react/functions/Checklist.html index e653e6cf36..7aeadd5651 100644 --- a/platform-bible-react/functions/Checklist.html +++ b/platform-bible-react/functions/Checklist.html @@ -1,3 +1,3 @@ Checklist | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 5e61878283..1a00cd9123 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react
                \ No newline at end of file +

                Type Parameters

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/ContextMenu.html b/platform-bible-react/functions/ContextMenu.html index 9d2c0c1f96..0cbe68d066 100644 --- a/platform-bible-react/functions/ContextMenu.html +++ b/platform-bible-react/functions/ContextMenu.html @@ -4,4 +4,4 @@ component which define what menu items to display and supply a command handler for when a menu item is clicked.

                Returns undefined | null | string | number | boolean | Iterable<ReactNode> | Element

                The ContextMenu component (including the wrapped children)

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/functions/DropdownMenu.html b/platform-bible-react/functions/DropdownMenu.html index 7ad7f54208..7502cd8303 100644 --- a/platform-bible-react/functions/DropdownMenu.html +++ b/platform-bible-react/functions/DropdownMenu.html @@ -1,4 +1,4 @@ -DropdownMenu | platform-bible-react

                Properties

                contextTypes? +DropdownMenu | platform-bible-react

                Properties

                contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuCheckboxItem.html b/platform-bible-react/functions/DropdownMenuCheckboxItem.html index a1af9b442e..ed60e73235 100644 --- a/platform-bible-react/functions/DropdownMenuCheckboxItem.html +++ b/platform-bible-react/functions/DropdownMenuCheckboxItem.html @@ -1,4 +1,4 @@ -DropdownMenuCheckboxItem | platform-bible-react

                Function DropdownMenuCheckboxItem

                Properties

                $$typeof +DropdownMenuCheckboxItem | platform-bible-react

                Function DropdownMenuCheckboxItem

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuContent.html b/platform-bible-react/functions/DropdownMenuContent.html index 9d4f48f4af..c39a8577c3 100644 --- a/platform-bible-react/functions/DropdownMenuContent.html +++ b/platform-bible-react/functions/DropdownMenuContent.html @@ -1,4 +1,4 @@ -DropdownMenuContent | platform-bible-react

                Function DropdownMenuContent

                Properties

                $$typeof +DropdownMenuContent | platform-bible-react

                Function DropdownMenuContent

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuGroup.html b/platform-bible-react/functions/DropdownMenuGroup.html index aa3f52fe21..a2f62539c8 100644 --- a/platform-bible-react/functions/DropdownMenuGroup.html +++ b/platform-bible-react/functions/DropdownMenuGroup.html @@ -1,4 +1,4 @@ -DropdownMenuGroup | platform-bible-react

                Function DropdownMenuGroup

                Properties

                $$typeof +DropdownMenuGroup | platform-bible-react

                Function DropdownMenuGroup

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuItem.html b/platform-bible-react/functions/DropdownMenuItem.html index 402d78dbc2..b7c98cc358 100644 --- a/platform-bible-react/functions/DropdownMenuItem.html +++ b/platform-bible-react/functions/DropdownMenuItem.html @@ -1,4 +1,4 @@ -DropdownMenuItem | platform-bible-react

                Function DropdownMenuItem

                Properties

                $$typeof +DropdownMenuItem | platform-bible-react

                Function DropdownMenuItem

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuLabel.html b/platform-bible-react/functions/DropdownMenuLabel.html index 6c6fed0b67..5908fc7c45 100644 --- a/platform-bible-react/functions/DropdownMenuLabel.html +++ b/platform-bible-react/functions/DropdownMenuLabel.html @@ -1,4 +1,4 @@ -DropdownMenuLabel | platform-bible-react

                Function DropdownMenuLabel

                Properties

                $$typeof +DropdownMenuLabel | platform-bible-react

                Function DropdownMenuLabel

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuPortal.html b/platform-bible-react/functions/DropdownMenuPortal.html index ce5241da9c..a391e62858 100644 --- a/platform-bible-react/functions/DropdownMenuPortal.html +++ b/platform-bible-react/functions/DropdownMenuPortal.html @@ -1,4 +1,4 @@ -DropdownMenuPortal | platform-bible-react

                Function DropdownMenuPortal

                Properties

                contextTypes? +DropdownMenuPortal | platform-bible-react

                Function DropdownMenuPortal

                Properties

                contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioGroup.html b/platform-bible-react/functions/DropdownMenuRadioGroup.html index c0a33566d5..5ee28a7ad8 100644 --- a/platform-bible-react/functions/DropdownMenuRadioGroup.html +++ b/platform-bible-react/functions/DropdownMenuRadioGroup.html @@ -1,4 +1,4 @@ -DropdownMenuRadioGroup | platform-bible-react

                Function DropdownMenuRadioGroup

                Properties

                $$typeof +DropdownMenuRadioGroup | platform-bible-react

                Function DropdownMenuRadioGroup

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioItem.html b/platform-bible-react/functions/DropdownMenuRadioItem.html index 295865d6bc..7300e16dc1 100644 --- a/platform-bible-react/functions/DropdownMenuRadioItem.html +++ b/platform-bible-react/functions/DropdownMenuRadioItem.html @@ -1,4 +1,4 @@ -DropdownMenuRadioItem | platform-bible-react

                Function DropdownMenuRadioItem

                Properties

                $$typeof +DropdownMenuRadioItem | platform-bible-react

                Function DropdownMenuRadioItem

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSeparator.html b/platform-bible-react/functions/DropdownMenuSeparator.html index 53a1cbd9b4..bd175bb604 100644 --- a/platform-bible-react/functions/DropdownMenuSeparator.html +++ b/platform-bible-react/functions/DropdownMenuSeparator.html @@ -1,4 +1,4 @@ -DropdownMenuSeparator | platform-bible-react

                Function DropdownMenuSeparator

                Properties

                $$typeof +DropdownMenuSeparator | platform-bible-react

                Function DropdownMenuSeparator

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuShortcut.html b/platform-bible-react/functions/DropdownMenuShortcut.html index edbab929a3..a34bbf7df3 100644 --- a/platform-bible-react/functions/DropdownMenuShortcut.html +++ b/platform-bible-react/functions/DropdownMenuShortcut.html @@ -1,2 +1,2 @@ -DropdownMenuShortcut | platform-bible-react

                Function DropdownMenuShortcut

                Properties

                Properties

                displayName: string
                \ No newline at end of file +DropdownMenuShortcut | platform-bible-react

                Function DropdownMenuShortcut

                Properties

                Properties

                displayName: string
                \ No newline at end of file diff --git a/platform-bible-react/functions/DropdownMenuSub.html b/platform-bible-react/functions/DropdownMenuSub.html index fc20edcdce..41f5b7e30d 100644 --- a/platform-bible-react/functions/DropdownMenuSub.html +++ b/platform-bible-react/functions/DropdownMenuSub.html @@ -1,4 +1,4 @@ -DropdownMenuSub | platform-bible-react

                Function DropdownMenuSub

                Properties

                contextTypes? +DropdownMenuSub | platform-bible-react

                Function DropdownMenuSub

                Properties

                contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubContent.html b/platform-bible-react/functions/DropdownMenuSubContent.html index 8cf5e01c8a..60891269e1 100644 --- a/platform-bible-react/functions/DropdownMenuSubContent.html +++ b/platform-bible-react/functions/DropdownMenuSubContent.html @@ -1,4 +1,4 @@ -DropdownMenuSubContent | platform-bible-react

                Function DropdownMenuSubContent

                Properties

                $$typeof +DropdownMenuSubContent | platform-bible-react

                Function DropdownMenuSubContent

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubTrigger.html b/platform-bible-react/functions/DropdownMenuSubTrigger.html index c54f22ce67..4468174a2f 100644 --- a/platform-bible-react/functions/DropdownMenuSubTrigger.html +++ b/platform-bible-react/functions/DropdownMenuSubTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuSubTrigger | platform-bible-react

                Function DropdownMenuSubTrigger

                Properties

                $$typeof +DropdownMenuSubTrigger | platform-bible-react

                Function DropdownMenuSubTrigger

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuTrigger.html b/platform-bible-react/functions/DropdownMenuTrigger.html index 77d25fc2d0..fb632af862 100644 --- a/platform-bible-react/functions/DropdownMenuTrigger.html +++ b/platform-bible-react/functions/DropdownMenuTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuTrigger | platform-bible-react

                Function DropdownMenuTrigger

                Properties

                $$typeof +DropdownMenuTrigger | platform-bible-react

                Function DropdownMenuTrigger

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index 43edb6eefe..3c1069a41e 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react
                \ No newline at end of file +GridMenu | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index 1b85ec91ae..ea958e6f7d 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

                Function HamburgerMenuButton

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

                Function HamburgerMenuButton

                \ No newline at end of file diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index a1d33dd424..c211dfcba8 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Input.html b/platform-bible-react/functions/Input.html index 3f0f3081f7..c0d9c6e0f5 100644 --- a/platform-bible-react/functions/Input.html +++ b/platform-bible-react/functions/Input.html @@ -1,4 +1,4 @@ -Input | platform-bible-react

                Properties

                $$typeof +Input | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index c345039259..cbe6eca6fe 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react
                \ No newline at end of file +MenuItem | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/RefSelector.html b/platform-bible-react/functions/RefSelector.html index 9579f1bfb4..ef9f20db14 100644 --- a/platform-bible-react/functions/RefSelector.html +++ b/platform-bible-react/functions/RefSelector.html @@ -1 +1 @@ -RefSelector | platform-bible-react
                \ No newline at end of file +RefSelector | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index 720abc9446..e88f1dda1d 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react
                \ No newline at end of file +SearchBar | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index c8e602b376..427e26b2f1 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ Slider | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Snackbar.html b/platform-bible-react/functions/Snackbar.html index 220f225d79..ecbf070fd1 100644 --- a/platform-bible-react/functions/Snackbar.html +++ b/platform-bible-react/functions/Snackbar.html @@ -1,4 +1,4 @@ Snackbar | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index ddc08725c8..3560c6a060 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ Switch | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index e9765d8d17..450a8ef515 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ Table | platform-bible-react
                \ No newline at end of file +

                Type Parameters

                • R

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Tabs.html b/platform-bible-react/functions/Tabs.html index b645081dc7..ea7719f62c 100644 --- a/platform-bible-react/functions/Tabs.html +++ b/platform-bible-react/functions/Tabs.html @@ -1,4 +1,4 @@ -Tabs | platform-bible-react

                Properties

                $$typeof +Tabs | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsContent.html b/platform-bible-react/functions/TabsContent.html index 42f37ef47e..7f5b964150 100644 --- a/platform-bible-react/functions/TabsContent.html +++ b/platform-bible-react/functions/TabsContent.html @@ -1,4 +1,4 @@ -TabsContent | platform-bible-react

                Properties

                $$typeof +TabsContent | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsList.html b/platform-bible-react/functions/TabsList.html index 64b3cac86a..4066b8147f 100644 --- a/platform-bible-react/functions/TabsList.html +++ b/platform-bible-react/functions/TabsList.html @@ -1,4 +1,4 @@ -TabsList | platform-bible-react

                Properties

                $$typeof +TabsList | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsTrigger.html b/platform-bible-react/functions/TabsTrigger.html index 71c41efc5e..a9dd98f2da 100644 --- a/platform-bible-react/functions/TabsTrigger.html +++ b/platform-bible-react/functions/TabsTrigger.html @@ -1,4 +1,4 @@ -TabsTrigger | platform-bible-react

                Properties

                $$typeof +TabsTrigger | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index c75187a38a..338fd8cb95 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react
                \ No newline at end of file +

                Parameters

                Returns Element

                \ No newline at end of file diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index dc219b2361..652ca52014 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react
                \ No newline at end of file +Toolbar | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/functions/VerticalTabs.html b/platform-bible-react/functions/VerticalTabs.html index 4a3084f76b..3022c17c5a 100644 --- a/platform-bible-react/functions/VerticalTabs.html +++ b/platform-bible-react/functions/VerticalTabs.html @@ -1,4 +1,4 @@ -VerticalTabs | platform-bible-react

                Properties

                $$typeof +VerticalTabs | platform-bible-react

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsContent.html b/platform-bible-react/functions/VerticalTabsContent.html index e139407b4c..1b92ce51b9 100644 --- a/platform-bible-react/functions/VerticalTabsContent.html +++ b/platform-bible-react/functions/VerticalTabsContent.html @@ -1,4 +1,4 @@ -VerticalTabsContent | platform-bible-react

                Function VerticalTabsContent

                Properties

                $$typeof +VerticalTabsContent | platform-bible-react

                Function VerticalTabsContent

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsList.html b/platform-bible-react/functions/VerticalTabsList.html index 76b974e257..b4bb6bbd23 100644 --- a/platform-bible-react/functions/VerticalTabsList.html +++ b/platform-bible-react/functions/VerticalTabsList.html @@ -1,4 +1,4 @@ -VerticalTabsList | platform-bible-react

                Function VerticalTabsList

                Properties

                $$typeof +VerticalTabsList | platform-bible-react

                Function VerticalTabsList

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsTrigger.html b/platform-bible-react/functions/VerticalTabsTrigger.html index 2905764983..c5984c261e 100644 --- a/platform-bible-react/functions/VerticalTabsTrigger.html +++ b/platform-bible-react/functions/VerticalTabsTrigger.html @@ -1,4 +1,4 @@ -VerticalTabsTrigger | platform-bible-react

                Function VerticalTabsTrigger

                Properties

                $$typeof +VerticalTabsTrigger | platform-bible-react

                Function VerticalTabsTrigger

                Properties

                $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/buttonVariants.html b/platform-bible-react/functions/buttonVariants.html index f7b8c836d7..84e75f995f 100644 --- a/platform-bible-react/functions/buttonVariants.html +++ b/platform-bible-react/functions/buttonVariants.html @@ -1 +1 @@ -buttonVariants | platform-bible-react

                Function buttonVariants

                • Parameters

                  • Optional props: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

                  Returns string

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

                Function buttonVariants

                • Parameters

                  • Optional props: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

                  Returns string

                \ No newline at end of file diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index a0875fed67..411bad1670 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

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index bf60cfe32d..05998fe242 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

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index b8a6504745..52c496d797 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
              • -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/interfaces/ButtonProps.html b/platform-bible-react/interfaces/ButtonProps.html index 24e4b4eb39..131e4181ec 100644 --- a/platform-bible-react/interfaces/ButtonProps.html +++ b/platform-bible-react/interfaces/ButtonProps.html @@ -1,4 +1,4 @@ -ButtonProps | platform-bible-react

                Interface ButtonProps

                interface ButtonProps {
                    about?: string;
                    accessKey?: string;
                    aria-activedescendant?: string;
                    aria-atomic?: Booleanish;
                    aria-autocomplete?: "inline" | "both" | "none" | "list";
                    aria-braillelabel?: string;
                    aria-brailleroledescription?: string;
                    aria-busy?: Booleanish;
                    aria-checked?: boolean | "false" | "mixed" | "true";
                    aria-colcount?: number;
                    aria-colindex?: number;
                    aria-colindextext?: string;
                    aria-colspan?: number;
                    aria-controls?: string;
                    aria-current?: boolean | "false" | "time" | "location" | "page" | "true" | "step" | "date";
                    aria-describedby?: string;
                    aria-description?: string;
                    aria-details?: string;
                    aria-disabled?: Booleanish;
                    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup";
                    aria-errormessage?: string;
                    aria-expanded?: Booleanish;
                    aria-flowto?: string;
                    aria-grabbed?: Booleanish;
                    aria-haspopup?: boolean | "false" | "grid" | "dialog" | "menu" | "listbox" | "true" | "tree";
                    aria-hidden?: Booleanish;
                    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling";
                    aria-keyshortcuts?: string;
                    aria-label?: string;
                    aria-labelledby?: string;
                    aria-level?: number;
                    aria-live?: "off" | "assertive" | "polite";
                    aria-modal?: Booleanish;
                    aria-multiline?: Booleanish;
                    aria-multiselectable?: Booleanish;
                    aria-orientation?: "horizontal" | "vertical";
                    aria-owns?: string;
                    aria-placeholder?: string;
                    aria-posinset?: number;
                    aria-pressed?: boolean | "false" | "mixed" | "true";
                    aria-readonly?: Booleanish;
                    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
                    aria-required?: Booleanish;
                    aria-roledescription?: string;
                    aria-rowcount?: number;
                    aria-rowindex?: number;
                    aria-rowindextext?: string;
                    aria-rowspan?: number;
                    aria-selected?: Booleanish;
                    aria-setsize?: number;
                    aria-sort?: "none" | "other" | "ascending" | "descending";
                    aria-valuemax?: number;
                    aria-valuemin?: number;
                    aria-valuenow?: number;
                    aria-valuetext?: string;
                    asChild?: boolean;
                    autoCapitalize?: string;
                    autoCorrect?: string;
                    autoFocus?: boolean;
                    autoSave?: string;
                    children?: ReactNode;
                    className?: string;
                    color?: string;
                    content?: string;
                    contentEditable?: "inherit" | Booleanish | "plaintext-only";
                    contextMenu?: string;
                    dangerouslySetInnerHTML?: {
                        __html: string | TrustedHTML;
                    };
                    datatype?: string;
                    defaultChecked?: boolean;
                    defaultValue?: string | number | readonly string[];
                    dir?: string;
                    disabled?: boolean;
                    draggable?: Booleanish;
                    form?: string;
                    formAction?: string;
                    formEncType?: string;
                    formMethod?: string;
                    formNoValidate?: boolean;
                    formTarget?: string;
                    hidden?: boolean;
                    id?: string;
                    inlist?: any;
                    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal";
                    is?: string;
                    itemID?: string;
                    itemProp?: string;
                    itemRef?: string;
                    itemScope?: boolean;
                    itemType?: string;
                    lang?: string;
                    name?: string;
                    nonce?: string;
                    onAbort?: ReactEventHandler<HTMLButtonElement>;
                    onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
                    onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
                    onAuxClick?: MouseEventHandler<HTMLButtonElement>;
                    onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
                    onBeforeInput?: FormEventHandler<HTMLButtonElement>;
                    onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
                    onBlur?: FocusEventHandler<HTMLButtonElement>;
                    onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
                    onCanPlay?: ReactEventHandler<HTMLButtonElement>;
                    onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
                    onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
                    onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
                    onChange?: FormEventHandler<HTMLButtonElement>;
                    onChangeCapture?: FormEventHandler<HTMLButtonElement>;
                    onClick?: MouseEventHandler<HTMLButtonElement>;
                    onClickCapture?: MouseEventHandler<HTMLButtonElement>;
                    onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
                    onContextMenu?: MouseEventHandler<HTMLButtonElement>;
                    onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
                    onCopy?: ClipboardEventHandler<HTMLButtonElement>;
                    onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
                    onCut?: ClipboardEventHandler<HTMLButtonElement>;
                    onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
                    onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
                    onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
                    onDrag?: DragEventHandler<HTMLButtonElement>;
                    onDragCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragEnd?: DragEventHandler<HTMLButtonElement>;
                    onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragEnter?: DragEventHandler<HTMLButtonElement>;
                    onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragExit?: DragEventHandler<HTMLButtonElement>;
                    onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragLeave?: DragEventHandler<HTMLButtonElement>;
                    onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragOver?: DragEventHandler<HTMLButtonElement>;
                    onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragStart?: DragEventHandler<HTMLButtonElement>;
                    onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
                    onDrop?: DragEventHandler<HTMLButtonElement>;
                    onDropCapture?: DragEventHandler<HTMLButtonElement>;
                    onDurationChange?: ReactEventHandler<HTMLButtonElement>;
                    onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
                    onEmptied?: ReactEventHandler<HTMLButtonElement>;
                    onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
                    onEncrypted?: ReactEventHandler<HTMLButtonElement>;
                    onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
                    onEnded?: ReactEventHandler<HTMLButtonElement>;
                    onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
                    onError?: ReactEventHandler<HTMLButtonElement>;
                    onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
                    onFocus?: FocusEventHandler<HTMLButtonElement>;
                    onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
                    onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
                    onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
                    onInput?: FormEventHandler<HTMLButtonElement>;
                    onInputCapture?: FormEventHandler<HTMLButtonElement>;
                    onInvalid?: FormEventHandler<HTMLButtonElement>;
                    onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
                    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
                    onLoad?: ReactEventHandler<HTMLButtonElement>;
                    onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadStart?: ReactEventHandler<HTMLButtonElement>;
                    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedData?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
                    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
                    onMouseDown?: MouseEventHandler<HTMLButtonElement>;
                    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
                    onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
                    onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
                    onMouseMove?: MouseEventHandler<HTMLButtonElement>;
                    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
                    onMouseOut?: MouseEventHandler<HTMLButtonElement>;
                    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
                    onMouseOver?: MouseEventHandler<HTMLButtonElement>;
                    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
                    onMouseUp?: MouseEventHandler<HTMLButtonElement>;
                    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
                    onPaste?: ClipboardEventHandler<HTMLButtonElement>;
                    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
                    onPause?: ReactEventHandler<HTMLButtonElement>;
                    onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
                    onPlay?: ReactEventHandler<HTMLButtonElement>;
                    onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
                    onPlaying?: ReactEventHandler<HTMLButtonElement>;
                    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
                    onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
                    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerDown?: PointerEventHandler<HTMLButtonElement>;
                    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
                    onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
                    onPointerMove?: PointerEventHandler<HTMLButtonElement>;
                    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerOut?: PointerEventHandler<HTMLButtonElement>;
                    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerOver?: PointerEventHandler<HTMLButtonElement>;
                    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerUp?: PointerEventHandler<HTMLButtonElement>;
                    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
                    onProgress?: ReactEventHandler<HTMLButtonElement>;
                    onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
                    onRateChange?: ReactEventHandler<HTMLButtonElement>;
                    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
                    onReset?: FormEventHandler<HTMLButtonElement>;
                    onResetCapture?: FormEventHandler<HTMLButtonElement>;
                    onResize?: ReactEventHandler<HTMLButtonElement>;
                    onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
                    onScroll?: UIEventHandler<HTMLButtonElement>;
                    onScrollCapture?: UIEventHandler<HTMLButtonElement>;
                    onSeeked?: ReactEventHandler<HTMLButtonElement>;
                    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
                    onSeeking?: ReactEventHandler<HTMLButtonElement>;
                    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
                    onSelect?: ReactEventHandler<HTMLButtonElement>;
                    onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
                    onStalled?: ReactEventHandler<HTMLButtonElement>;
                    onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
                    onSubmit?: FormEventHandler<HTMLButtonElement>;
                    onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
                    onSuspend?: ReactEventHandler<HTMLButtonElement>;
                    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
                    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
                    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
                    onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
                    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
                    onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
                    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
                    onTouchMove?: TouchEventHandler<HTMLButtonElement>;
                    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
                    onTouchStart?: TouchEventHandler<HTMLButtonElement>;
                    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
                    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
                    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
                    onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
                    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
                    onWaiting?: ReactEventHandler<HTMLButtonElement>;
                    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
                    onWheel?: WheelEventHandler<HTMLButtonElement>;
                    onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
                    prefix?: string;
                    property?: string;
                    radioGroup?: string;
                    rel?: string;
                    resource?: string;
                    results?: number;
                    rev?: string;
                    role?: AriaRole;
                    security?: string;
                    size?: null | "default" | "icon" | "sm" | "lg";
                    slot?: string;
                    spellCheck?: Booleanish;
                    style?: CSSProperties;
                    suppressContentEditableWarning?: boolean;
                    suppressHydrationWarning?: boolean;
                    tabIndex?: number;
                    title?: string;
                    translate?: "yes" | "no";
                    type?: "button" | "reset" | "submit";
                    typeof?: string;
                    unselectable?: "off" | "on";
                    value?: string | number | readonly string[];
                    variant?: null | "link" | "default" | "outline" | "destructive" | "secondary" | "ghost";
                    vocab?: string;
                }

                Hierarchy

                • ButtonHTMLAttributes<HTMLButtonElement>
                • VariantProps<typeof buttonVariants>
                  • ButtonProps

                Properties

                about? +ButtonProps | platform-bible-react

                Interface ButtonProps

                interface ButtonProps {
                    about?: string;
                    accessKey?: string;
                    aria-activedescendant?: string;
                    aria-atomic?: Booleanish;
                    aria-autocomplete?: "inline" | "both" | "none" | "list";
                    aria-braillelabel?: string;
                    aria-brailleroledescription?: string;
                    aria-busy?: Booleanish;
                    aria-checked?: boolean | "false" | "mixed" | "true";
                    aria-colcount?: number;
                    aria-colindex?: number;
                    aria-colindextext?: string;
                    aria-colspan?: number;
                    aria-controls?: string;
                    aria-current?: boolean | "false" | "time" | "location" | "page" | "true" | "step" | "date";
                    aria-describedby?: string;
                    aria-description?: string;
                    aria-details?: string;
                    aria-disabled?: Booleanish;
                    aria-dropeffect?: "link" | "none" | "copy" | "move" | "execute" | "popup";
                    aria-errormessage?: string;
                    aria-expanded?: Booleanish;
                    aria-flowto?: string;
                    aria-grabbed?: Booleanish;
                    aria-haspopup?: boolean | "false" | "grid" | "dialog" | "menu" | "listbox" | "true" | "tree";
                    aria-hidden?: Booleanish;
                    aria-invalid?: boolean | "false" | "true" | "grammar" | "spelling";
                    aria-keyshortcuts?: string;
                    aria-label?: string;
                    aria-labelledby?: string;
                    aria-level?: number;
                    aria-live?: "off" | "assertive" | "polite";
                    aria-modal?: Booleanish;
                    aria-multiline?: Booleanish;
                    aria-multiselectable?: Booleanish;
                    aria-orientation?: "horizontal" | "vertical";
                    aria-owns?: string;
                    aria-placeholder?: string;
                    aria-posinset?: number;
                    aria-pressed?: boolean | "false" | "mixed" | "true";
                    aria-readonly?: Booleanish;
                    aria-relevant?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
                    aria-required?: Booleanish;
                    aria-roledescription?: string;
                    aria-rowcount?: number;
                    aria-rowindex?: number;
                    aria-rowindextext?: string;
                    aria-rowspan?: number;
                    aria-selected?: Booleanish;
                    aria-setsize?: number;
                    aria-sort?: "none" | "other" | "ascending" | "descending";
                    aria-valuemax?: number;
                    aria-valuemin?: number;
                    aria-valuenow?: number;
                    aria-valuetext?: string;
                    asChild?: boolean;
                    autoCapitalize?: string;
                    autoCorrect?: string;
                    autoFocus?: boolean;
                    autoSave?: string;
                    children?: ReactNode;
                    className?: string;
                    color?: string;
                    content?: string;
                    contentEditable?: "inherit" | Booleanish | "plaintext-only";
                    contextMenu?: string;
                    dangerouslySetInnerHTML?: {
                        __html: string | TrustedHTML;
                    };
                    datatype?: string;
                    defaultChecked?: boolean;
                    defaultValue?: string | number | readonly string[];
                    dir?: string;
                    disabled?: boolean;
                    draggable?: Booleanish;
                    form?: string;
                    formAction?: string;
                    formEncType?: string;
                    formMethod?: string;
                    formNoValidate?: boolean;
                    formTarget?: string;
                    hidden?: boolean;
                    id?: string;
                    inlist?: any;
                    inputMode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal";
                    is?: string;
                    itemID?: string;
                    itemProp?: string;
                    itemRef?: string;
                    itemScope?: boolean;
                    itemType?: string;
                    lang?: string;
                    name?: string;
                    nonce?: string;
                    onAbort?: ReactEventHandler<HTMLButtonElement>;
                    onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
                    onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
                    onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
                    onAuxClick?: MouseEventHandler<HTMLButtonElement>;
                    onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
                    onBeforeInput?: FormEventHandler<HTMLButtonElement>;
                    onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
                    onBlur?: FocusEventHandler<HTMLButtonElement>;
                    onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
                    onCanPlay?: ReactEventHandler<HTMLButtonElement>;
                    onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
                    onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
                    onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
                    onChange?: FormEventHandler<HTMLButtonElement>;
                    onChangeCapture?: FormEventHandler<HTMLButtonElement>;
                    onClick?: MouseEventHandler<HTMLButtonElement>;
                    onClickCapture?: MouseEventHandler<HTMLButtonElement>;
                    onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
                    onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
                    onContextMenu?: MouseEventHandler<HTMLButtonElement>;
                    onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
                    onCopy?: ClipboardEventHandler<HTMLButtonElement>;
                    onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
                    onCut?: ClipboardEventHandler<HTMLButtonElement>;
                    onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
                    onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
                    onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
                    onDrag?: DragEventHandler<HTMLButtonElement>;
                    onDragCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragEnd?: DragEventHandler<HTMLButtonElement>;
                    onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragEnter?: DragEventHandler<HTMLButtonElement>;
                    onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragExit?: DragEventHandler<HTMLButtonElement>;
                    onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragLeave?: DragEventHandler<HTMLButtonElement>;
                    onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragOver?: DragEventHandler<HTMLButtonElement>;
                    onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
                    onDragStart?: DragEventHandler<HTMLButtonElement>;
                    onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
                    onDrop?: DragEventHandler<HTMLButtonElement>;
                    onDropCapture?: DragEventHandler<HTMLButtonElement>;
                    onDurationChange?: ReactEventHandler<HTMLButtonElement>;
                    onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
                    onEmptied?: ReactEventHandler<HTMLButtonElement>;
                    onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
                    onEncrypted?: ReactEventHandler<HTMLButtonElement>;
                    onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
                    onEnded?: ReactEventHandler<HTMLButtonElement>;
                    onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
                    onError?: ReactEventHandler<HTMLButtonElement>;
                    onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
                    onFocus?: FocusEventHandler<HTMLButtonElement>;
                    onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
                    onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
                    onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
                    onInput?: FormEventHandler<HTMLButtonElement>;
                    onInputCapture?: FormEventHandler<HTMLButtonElement>;
                    onInvalid?: FormEventHandler<HTMLButtonElement>;
                    onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
                    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
                    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
                    onLoad?: ReactEventHandler<HTMLButtonElement>;
                    onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadStart?: ReactEventHandler<HTMLButtonElement>;
                    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedData?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
                    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
                    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
                    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
                    onMouseDown?: MouseEventHandler<HTMLButtonElement>;
                    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
                    onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
                    onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
                    onMouseMove?: MouseEventHandler<HTMLButtonElement>;
                    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
                    onMouseOut?: MouseEventHandler<HTMLButtonElement>;
                    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
                    onMouseOver?: MouseEventHandler<HTMLButtonElement>;
                    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
                    onMouseUp?: MouseEventHandler<HTMLButtonElement>;
                    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
                    onPaste?: ClipboardEventHandler<HTMLButtonElement>;
                    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
                    onPause?: ReactEventHandler<HTMLButtonElement>;
                    onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
                    onPlay?: ReactEventHandler<HTMLButtonElement>;
                    onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
                    onPlaying?: ReactEventHandler<HTMLButtonElement>;
                    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
                    onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
                    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerDown?: PointerEventHandler<HTMLButtonElement>;
                    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
                    onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
                    onPointerMove?: PointerEventHandler<HTMLButtonElement>;
                    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerOut?: PointerEventHandler<HTMLButtonElement>;
                    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerOver?: PointerEventHandler<HTMLButtonElement>;
                    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
                    onPointerUp?: PointerEventHandler<HTMLButtonElement>;
                    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
                    onProgress?: ReactEventHandler<HTMLButtonElement>;
                    onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
                    onRateChange?: ReactEventHandler<HTMLButtonElement>;
                    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
                    onReset?: FormEventHandler<HTMLButtonElement>;
                    onResetCapture?: FormEventHandler<HTMLButtonElement>;
                    onResize?: ReactEventHandler<HTMLButtonElement>;
                    onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
                    onScroll?: UIEventHandler<HTMLButtonElement>;
                    onScrollCapture?: UIEventHandler<HTMLButtonElement>;
                    onSeeked?: ReactEventHandler<HTMLButtonElement>;
                    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
                    onSeeking?: ReactEventHandler<HTMLButtonElement>;
                    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
                    onSelect?: ReactEventHandler<HTMLButtonElement>;
                    onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
                    onStalled?: ReactEventHandler<HTMLButtonElement>;
                    onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
                    onSubmit?: FormEventHandler<HTMLButtonElement>;
                    onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
                    onSuspend?: ReactEventHandler<HTMLButtonElement>;
                    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
                    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
                    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
                    onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
                    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
                    onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
                    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
                    onTouchMove?: TouchEventHandler<HTMLButtonElement>;
                    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
                    onTouchStart?: TouchEventHandler<HTMLButtonElement>;
                    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
                    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
                    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
                    onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
                    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
                    onWaiting?: ReactEventHandler<HTMLButtonElement>;
                    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
                    onWheel?: WheelEventHandler<HTMLButtonElement>;
                    onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
                    prefix?: string;
                    property?: string;
                    radioGroup?: string;
                    rel?: string;
                    resource?: string;
                    results?: number;
                    rev?: string;
                    role?: AriaRole;
                    security?: string;
                    size?: null | "default" | "icon" | "sm" | "lg";
                    slot?: string;
                    spellCheck?: Booleanish;
                    style?: CSSProperties;
                    suppressContentEditableWarning?: boolean;
                    suppressHydrationWarning?: boolean;
                    tabIndex?: number;
                    title?: string;
                    translate?: "yes" | "no";
                    type?: "button" | "reset" | "submit";
                    typeof?: string;
                    unselectable?: "off" | "on";
                    value?: string | number | readonly string[];
                    variant?: null | "link" | "default" | "outline" | "destructive" | "secondary" | "ghost";
                    vocab?: string;
                }

                Hierarchy

                • ButtonHTMLAttributes<HTMLButtonElement>
                • VariantProps<typeof buttonVariants>
                  • ButtonProps

                Properties

                aria-valuenow?: number

                Defines the current value for a range widget.

                See

                aria-valuetext.

                aria-valuetext?: string

                Defines the human readable text alternative of aria-valuenow for a range widget.

                -
                asChild?: boolean
                autoCapitalize?: string
                autoCorrect?: string
                autoFocus?: boolean
                autoSave?: string
                children?: ReactNode
                className?: string
                color?: string
                content?: string
                contentEditable?: "inherit" | Booleanish | "plaintext-only"
                contextMenu?: string
                dangerouslySetInnerHTML?: {
                    __html: string | TrustedHTML;
                }

                Type declaration

                • __html: string | TrustedHTML
                datatype?: string
                defaultChecked?: boolean
                defaultValue?: string | number | readonly string[]
                dir?: string
                disabled?: boolean
                draggable?: Booleanish
                form?: string
                formAction?: string
                formEncType?: string
                formMethod?: string
                formNoValidate?: boolean
                formTarget?: string
                hidden?: boolean
                id?: string
                inlist?: any
                inputMode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal"

                Hints at the type of data that might be entered by the user while editing the element or its contents

                +
                asChild?: boolean
                autoCapitalize?: string
                autoCorrect?: string
                autoFocus?: boolean
                autoSave?: string
                children?: ReactNode
                className?: string
                color?: string
                content?: string
                contentEditable?: "inherit" | Booleanish | "plaintext-only"
                contextMenu?: string
                dangerouslySetInnerHTML?: {
                    __html: string | TrustedHTML;
                }

                Type declaration

                • __html: string | TrustedHTML
                datatype?: string
                defaultChecked?: boolean
                defaultValue?: string | number | readonly string[]
                dir?: string
                disabled?: boolean
                draggable?: Booleanish
                form?: string
                formAction?: string
                formEncType?: string
                formMethod?: string
                formNoValidate?: boolean
                formTarget?: string
                hidden?: boolean
                id?: string
                inlist?: any
                inputMode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal"

                Hints at the type of data that might be entered by the user while editing the element or its contents

                is?: string

                Specify that a standard HTML element should behave like a defined custom built-in element

                itemID?: string
                itemProp?: string
                itemRef?: string
                itemScope?: boolean
                itemType?: string
                lang?: string
                name?: string
                nonce?: string
                onAbort?: ReactEventHandler<HTMLButtonElement>
                onAbortCapture?: ReactEventHandler<HTMLButtonElement>
                onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>
                onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>
                onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>
                onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>
                onAnimationStart?: AnimationEventHandler<HTMLButtonElement>
                onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>
                onAuxClick?: MouseEventHandler<HTMLButtonElement>
                onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>
                onBeforeInput?: FormEventHandler<HTMLButtonElement>
                onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>
                onBlur?: FocusEventHandler<HTMLButtonElement>
                onBlurCapture?: FocusEventHandler<HTMLButtonElement>
                onCanPlay?: ReactEventHandler<HTMLButtonElement>
                onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>
                onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>
                onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>
                onChange?: FormEventHandler<HTMLButtonElement>
                onChangeCapture?: FormEventHandler<HTMLButtonElement>
                onClick?: MouseEventHandler<HTMLButtonElement>
                onClickCapture?: MouseEventHandler<HTMLButtonElement>
                onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>
                onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>
                onCompositionStart?: CompositionEventHandler<HTMLButtonElement>
                onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>
                onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>
                onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>
                onContextMenu?: MouseEventHandler<HTMLButtonElement>
                onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>
                onCopy?: ClipboardEventHandler<HTMLButtonElement>
                onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>
                onCut?: ClipboardEventHandler<HTMLButtonElement>
                onCutCapture?: ClipboardEventHandler<HTMLButtonElement>
                onDoubleClick?: MouseEventHandler<HTMLButtonElement>
                onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>
                onDrag?: DragEventHandler<HTMLButtonElement>
                onDragCapture?: DragEventHandler<HTMLButtonElement>
                onDragEnd?: DragEventHandler<HTMLButtonElement>
                onDragEndCapture?: DragEventHandler<HTMLButtonElement>
                onDragEnter?: DragEventHandler<HTMLButtonElement>
                onDragEnterCapture?: DragEventHandler<HTMLButtonElement>
                onDragExit?: DragEventHandler<HTMLButtonElement>
                onDragExitCapture?: DragEventHandler<HTMLButtonElement>
                onDragLeave?: DragEventHandler<HTMLButtonElement>
                onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>
                onDragOver?: DragEventHandler<HTMLButtonElement>
                onDragOverCapture?: DragEventHandler<HTMLButtonElement>
                onDragStart?: DragEventHandler<HTMLButtonElement>
                onDragStartCapture?: DragEventHandler<HTMLButtonElement>
                onDrop?: DragEventHandler<HTMLButtonElement>
                onDropCapture?: DragEventHandler<HTMLButtonElement>
                onDurationChange?: ReactEventHandler<HTMLButtonElement>
                onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>
                onEmptied?: ReactEventHandler<HTMLButtonElement>
                onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>
                onEncrypted?: ReactEventHandler<HTMLButtonElement>
                onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>
                onEnded?: ReactEventHandler<HTMLButtonElement>
                onEndedCapture?: ReactEventHandler<HTMLButtonElement>
                onError?: ReactEventHandler<HTMLButtonElement>
                onErrorCapture?: ReactEventHandler<HTMLButtonElement>
                onFocus?: FocusEventHandler<HTMLButtonElement>
                onFocusCapture?: FocusEventHandler<HTMLButtonElement>
                onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>
                onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
                onInput?: FormEventHandler<HTMLButtonElement>
                onInputCapture?: FormEventHandler<HTMLButtonElement>
                onInvalid?: FormEventHandler<HTMLButtonElement>
                onInvalidCapture?: FormEventHandler<HTMLButtonElement>
                onKeyDown?: KeyboardEventHandler<HTMLButtonElement>
                onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>
                onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

                Deprecated

                onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

                Deprecated

                onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
                onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
                onLoad?: ReactEventHandler<HTMLButtonElement>
                onLoadCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadStart?: ReactEventHandler<HTMLButtonElement>
                onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadedData?: ReactEventHandler<HTMLButtonElement>
                onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
                onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>
                onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>
                onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
                onMouseDown?: MouseEventHandler<HTMLButtonElement>
                onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>
                onMouseEnter?: MouseEventHandler<HTMLButtonElement>
                onMouseLeave?: MouseEventHandler<HTMLButtonElement>
                onMouseMove?: MouseEventHandler<HTMLButtonElement>
                onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>
                onMouseOut?: MouseEventHandler<HTMLButtonElement>
                onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>
                onMouseOver?: MouseEventHandler<HTMLButtonElement>
                onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>
                onMouseUp?: MouseEventHandler<HTMLButtonElement>
                onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>
                onPaste?: ClipboardEventHandler<HTMLButtonElement>
                onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>
                onPause?: ReactEventHandler<HTMLButtonElement>
                onPauseCapture?: ReactEventHandler<HTMLButtonElement>
                onPlay?: ReactEventHandler<HTMLButtonElement>
                onPlayCapture?: ReactEventHandler<HTMLButtonElement>
                onPlaying?: ReactEventHandler<HTMLButtonElement>
                onPlayingCapture?: ReactEventHandler<HTMLButtonElement>
                onPointerCancel?: PointerEventHandler<HTMLButtonElement>
                onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerDown?: PointerEventHandler<HTMLButtonElement>
                onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerEnter?: PointerEventHandler<HTMLButtonElement>
                onPointerLeave?: PointerEventHandler<HTMLButtonElement>
                onPointerMove?: PointerEventHandler<HTMLButtonElement>
                onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerOut?: PointerEventHandler<HTMLButtonElement>
                onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerOver?: PointerEventHandler<HTMLButtonElement>
                onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerUp?: PointerEventHandler<HTMLButtonElement>
                onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>
                onProgress?: ReactEventHandler<HTMLButtonElement>
                onProgressCapture?: ReactEventHandler<HTMLButtonElement>
                onRateChange?: ReactEventHandler<HTMLButtonElement>
                onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>
                onReset?: FormEventHandler<HTMLButtonElement>
                onResetCapture?: FormEventHandler<HTMLButtonElement>
                onResize?: ReactEventHandler<HTMLButtonElement>
                onResizeCapture?: ReactEventHandler<HTMLButtonElement>
                onScroll?: UIEventHandler<HTMLButtonElement>
                onScrollCapture?: UIEventHandler<HTMLButtonElement>
                onSeeked?: ReactEventHandler<HTMLButtonElement>
                onSeekedCapture?: ReactEventHandler<HTMLButtonElement>
                onSeeking?: ReactEventHandler<HTMLButtonElement>
                onSeekingCapture?: ReactEventHandler<HTMLButtonElement>
                onSelect?: ReactEventHandler<HTMLButtonElement>
                onSelectCapture?: ReactEventHandler<HTMLButtonElement>
                onStalled?: ReactEventHandler<HTMLButtonElement>
                onStalledCapture?: ReactEventHandler<HTMLButtonElement>
                onSubmit?: FormEventHandler<HTMLButtonElement>
                onSubmitCapture?: FormEventHandler<HTMLButtonElement>
                onSuspend?: ReactEventHandler<HTMLButtonElement>
                onSuspendCapture?: ReactEventHandler<HTMLButtonElement>
                onTimeUpdate?: ReactEventHandler<HTMLButtonElement>
                onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>
                onTouchCancel?: TouchEventHandler<HTMLButtonElement>
                onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>
                onTouchEnd?: TouchEventHandler<HTMLButtonElement>
                onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>
                onTouchMove?: TouchEventHandler<HTMLButtonElement>
                onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>
                onTouchStart?: TouchEventHandler<HTMLButtonElement>
                onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>
                onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>
                onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>
                onVolumeChange?: ReactEventHandler<HTMLButtonElement>
                onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>
                onWaiting?: ReactEventHandler<HTMLButtonElement>
                onWaitingCapture?: ReactEventHandler<HTMLButtonElement>
                onWheel?: WheelEventHandler<HTMLButtonElement>
                onWheelCapture?: WheelEventHandler<HTMLButtonElement>
                prefix?: string
                property?: string
                radioGroup?: string
                rel?: string
                resource?: string
                results?: number
                rev?: string
                role?: AriaRole
                security?: string
                size?: null | "default" | "icon" | "sm" | "lg" = ...
                slot?: string
                spellCheck?: Booleanish
                style?: CSSProperties
                suppressContentEditableWarning?: boolean
                suppressHydrationWarning?: boolean
                tabIndex?: number
                title?: string
                translate?: "yes" | "no"
                type?: "button" | "reset" | "submit"
                typeof?: string
                unselectable?: "off" | "on"
                value?: string | number | readonly string[]
                variant?: null | "link" | "default" | "outline" | "destructive" | "secondary" | "ghost" = ...
                vocab?: string
                \ No newline at end of file +
                itemID?: string
                itemProp?: string
                itemRef?: string
                itemScope?: boolean
                itemType?: string
                lang?: string
                name?: string
                nonce?: string
                onAbort?: ReactEventHandler<HTMLButtonElement>
                onAbortCapture?: ReactEventHandler<HTMLButtonElement>
                onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>
                onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>
                onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>
                onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>
                onAnimationStart?: AnimationEventHandler<HTMLButtonElement>
                onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>
                onAuxClick?: MouseEventHandler<HTMLButtonElement>
                onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>
                onBeforeInput?: FormEventHandler<HTMLButtonElement>
                onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>
                onBlur?: FocusEventHandler<HTMLButtonElement>
                onBlurCapture?: FocusEventHandler<HTMLButtonElement>
                onCanPlay?: ReactEventHandler<HTMLButtonElement>
                onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>
                onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>
                onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>
                onChange?: FormEventHandler<HTMLButtonElement>
                onChangeCapture?: FormEventHandler<HTMLButtonElement>
                onClick?: MouseEventHandler<HTMLButtonElement>
                onClickCapture?: MouseEventHandler<HTMLButtonElement>
                onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>
                onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>
                onCompositionStart?: CompositionEventHandler<HTMLButtonElement>
                onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>
                onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>
                onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>
                onContextMenu?: MouseEventHandler<HTMLButtonElement>
                onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>
                onCopy?: ClipboardEventHandler<HTMLButtonElement>
                onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>
                onCut?: ClipboardEventHandler<HTMLButtonElement>
                onCutCapture?: ClipboardEventHandler<HTMLButtonElement>
                onDoubleClick?: MouseEventHandler<HTMLButtonElement>
                onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>
                onDrag?: DragEventHandler<HTMLButtonElement>
                onDragCapture?: DragEventHandler<HTMLButtonElement>
                onDragEnd?: DragEventHandler<HTMLButtonElement>
                onDragEndCapture?: DragEventHandler<HTMLButtonElement>
                onDragEnter?: DragEventHandler<HTMLButtonElement>
                onDragEnterCapture?: DragEventHandler<HTMLButtonElement>
                onDragExit?: DragEventHandler<HTMLButtonElement>
                onDragExitCapture?: DragEventHandler<HTMLButtonElement>
                onDragLeave?: DragEventHandler<HTMLButtonElement>
                onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>
                onDragOver?: DragEventHandler<HTMLButtonElement>
                onDragOverCapture?: DragEventHandler<HTMLButtonElement>
                onDragStart?: DragEventHandler<HTMLButtonElement>
                onDragStartCapture?: DragEventHandler<HTMLButtonElement>
                onDrop?: DragEventHandler<HTMLButtonElement>
                onDropCapture?: DragEventHandler<HTMLButtonElement>
                onDurationChange?: ReactEventHandler<HTMLButtonElement>
                onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>
                onEmptied?: ReactEventHandler<HTMLButtonElement>
                onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>
                onEncrypted?: ReactEventHandler<HTMLButtonElement>
                onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>
                onEnded?: ReactEventHandler<HTMLButtonElement>
                onEndedCapture?: ReactEventHandler<HTMLButtonElement>
                onError?: ReactEventHandler<HTMLButtonElement>
                onErrorCapture?: ReactEventHandler<HTMLButtonElement>
                onFocus?: FocusEventHandler<HTMLButtonElement>
                onFocusCapture?: FocusEventHandler<HTMLButtonElement>
                onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>
                onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
                onInput?: FormEventHandler<HTMLButtonElement>
                onInputCapture?: FormEventHandler<HTMLButtonElement>
                onInvalid?: FormEventHandler<HTMLButtonElement>
                onInvalidCapture?: FormEventHandler<HTMLButtonElement>
                onKeyDown?: KeyboardEventHandler<HTMLButtonElement>
                onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>
                onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

                Deprecated

                onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

                Deprecated

                onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
                onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
                onLoad?: ReactEventHandler<HTMLButtonElement>
                onLoadCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadStart?: ReactEventHandler<HTMLButtonElement>
                onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadedData?: ReactEventHandler<HTMLButtonElement>
                onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
                onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
                onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>
                onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>
                onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
                onMouseDown?: MouseEventHandler<HTMLButtonElement>
                onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>
                onMouseEnter?: MouseEventHandler<HTMLButtonElement>
                onMouseLeave?: MouseEventHandler<HTMLButtonElement>
                onMouseMove?: MouseEventHandler<HTMLButtonElement>
                onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>
                onMouseOut?: MouseEventHandler<HTMLButtonElement>
                onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>
                onMouseOver?: MouseEventHandler<HTMLButtonElement>
                onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>
                onMouseUp?: MouseEventHandler<HTMLButtonElement>
                onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>
                onPaste?: ClipboardEventHandler<HTMLButtonElement>
                onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>
                onPause?: ReactEventHandler<HTMLButtonElement>
                onPauseCapture?: ReactEventHandler<HTMLButtonElement>
                onPlay?: ReactEventHandler<HTMLButtonElement>
                onPlayCapture?: ReactEventHandler<HTMLButtonElement>
                onPlaying?: ReactEventHandler<HTMLButtonElement>
                onPlayingCapture?: ReactEventHandler<HTMLButtonElement>
                onPointerCancel?: PointerEventHandler<HTMLButtonElement>
                onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerDown?: PointerEventHandler<HTMLButtonElement>
                onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerEnter?: PointerEventHandler<HTMLButtonElement>
                onPointerLeave?: PointerEventHandler<HTMLButtonElement>
                onPointerMove?: PointerEventHandler<HTMLButtonElement>
                onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerOut?: PointerEventHandler<HTMLButtonElement>
                onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerOver?: PointerEventHandler<HTMLButtonElement>
                onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>
                onPointerUp?: PointerEventHandler<HTMLButtonElement>
                onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>
                onProgress?: ReactEventHandler<HTMLButtonElement>
                onProgressCapture?: ReactEventHandler<HTMLButtonElement>
                onRateChange?: ReactEventHandler<HTMLButtonElement>
                onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>
                onReset?: FormEventHandler<HTMLButtonElement>
                onResetCapture?: FormEventHandler<HTMLButtonElement>
                onResize?: ReactEventHandler<HTMLButtonElement>
                onResizeCapture?: ReactEventHandler<HTMLButtonElement>
                onScroll?: UIEventHandler<HTMLButtonElement>
                onScrollCapture?: UIEventHandler<HTMLButtonElement>
                onSeeked?: ReactEventHandler<HTMLButtonElement>
                onSeekedCapture?: ReactEventHandler<HTMLButtonElement>
                onSeeking?: ReactEventHandler<HTMLButtonElement>
                onSeekingCapture?: ReactEventHandler<HTMLButtonElement>
                onSelect?: ReactEventHandler<HTMLButtonElement>
                onSelectCapture?: ReactEventHandler<HTMLButtonElement>
                onStalled?: ReactEventHandler<HTMLButtonElement>
                onStalledCapture?: ReactEventHandler<HTMLButtonElement>
                onSubmit?: FormEventHandler<HTMLButtonElement>
                onSubmitCapture?: FormEventHandler<HTMLButtonElement>
                onSuspend?: ReactEventHandler<HTMLButtonElement>
                onSuspendCapture?: ReactEventHandler<HTMLButtonElement>
                onTimeUpdate?: ReactEventHandler<HTMLButtonElement>
                onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>
                onTouchCancel?: TouchEventHandler<HTMLButtonElement>
                onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>
                onTouchEnd?: TouchEventHandler<HTMLButtonElement>
                onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>
                onTouchMove?: TouchEventHandler<HTMLButtonElement>
                onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>
                onTouchStart?: TouchEventHandler<HTMLButtonElement>
                onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>
                onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>
                onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>
                onVolumeChange?: ReactEventHandler<HTMLButtonElement>
                onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>
                onWaiting?: ReactEventHandler<HTMLButtonElement>
                onWaitingCapture?: ReactEventHandler<HTMLButtonElement>
                onWheel?: WheelEventHandler<HTMLButtonElement>
                onWheelCapture?: WheelEventHandler<HTMLButtonElement>
                prefix?: string
                property?: string
                radioGroup?: string
                rel?: string
                resource?: string
                results?: number
                rev?: string
                role?: AriaRole
                security?: string
                size?: null | "default" | "icon" | "sm" | "lg" = ...
                slot?: string
                spellCheck?: Booleanish
                style?: CSSProperties
                suppressContentEditableWarning?: boolean
                suppressHydrationWarning?: boolean
                tabIndex?: number
                title?: string
                translate?: "yes" | "no"
                type?: "button" | "reset" | "submit"
                typeof?: string
                unselectable?: "off" | "on"
                value?: string | number | readonly string[]
                variant?: null | "link" | "default" | "outline" | "destructive" | "secondary" | "ghost" = ...
                vocab?: string
                \ No newline at end of file diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index a37516dbe9..47d6b6bce3 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)
                \ No newline at end of file +CommandHandler | platform-bible-react

                Interface CommandHandler

                interface CommandHandler ((command) => void)
                \ No newline at end of file diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index d2361ff5aa..644dfc7b1d 100644 --- a/platform-bible-react/interfaces/MultiColumnMenuProvider.html +++ b/platform-bible-react/interfaces/MultiColumnMenuProvider.html @@ -1 +1 @@ -MultiColumnMenuProvider | platform-bible-react

                Interface MultiColumnMenuProvider

                interface MultiColumnMenuProvider ((isSupportAndDevelopment) => Promise<{
                    columns: {
                        isExtensible?: boolean;
                    };
                    groups: {};
                    items: ({
                        group: string;
                        id: string;
                        label: string;
                        localizeNotes: string;
                        order: number;
                        searchTerms?: string;
                        tooltip?: string;
                    } | {
                        command: string;
                        group: string;
                        iconPathAfter?: string;
                        iconPathBefore?: string;
                        label: string;
                        localizeNotes: string;
                        order: number;
                        searchTerms?: string;
                        tooltip?: string;
                    })[];
                }>)
                • Parameters

                  • isSupportAndDevelopment: boolean

                  Returns Promise<{
                      columns: {
                          isExtensible?: boolean;
                      };
                      groups: {};
                      items: ({
                          group: string;
                          id: string;
                          label: string;
                          localizeNotes: string;
                          order: number;
                          searchTerms?: string;
                          tooltip?: string;
                      } | {
                          command: string;
                          group: string;
                          iconPathAfter?: string;
                          iconPathBefore?: string;
                          label: string;
                          localizeNotes: string;
                          order: number;
                          searchTerms?: string;
                          tooltip?: string;
                      })[];
                  }>

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

                Interface MultiColumnMenuProvider

                interface MultiColumnMenuProvider ((isSupportAndDevelopment) => Promise<{
                    columns: {
                        isExtensible?: boolean;
                    };
                    groups: {};
                    items: ({
                        group: string;
                        id: string;
                        label: string;
                        localizeNotes: string;
                        order: number;
                        searchTerms?: string;
                        tooltip?: string;
                    } | {
                        command: string;
                        group: string;
                        iconPathAfter?: string;
                        iconPathBefore?: string;
                        label: string;
                        localizeNotes: string;
                        order: number;
                        searchTerms?: string;
                        tooltip?: string;
                    })[];
                }>)
                • Parameters

                  • isSupportAndDevelopment: boolean

                  Returns Promise<{
                      columns: {
                          isExtensible?: boolean;
                      };
                      groups: {};
                      items: ({
                          group: string;
                          id: string;
                          label: string;
                          localizeNotes: string;
                          order: number;
                          searchTerms?: string;
                          tooltip?: string;
                      } | {
                          command: string;
                          group: string;
                          iconPathAfter?: string;
                          iconPathBefore?: string;
                          label: string;
                          localizeNotes: string;
                          order: number;
                          searchTerms?: string;
                          tooltip?: string;
                      })[];
                  }>

                \ No newline at end of file diff --git a/platform-bible-react/interfaces/ScrRefSelectorProps.html b/platform-bible-react/interfaces/ScrRefSelectorProps.html index 36d41220d3..cff0f11c62 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
                \ No newline at end of file +

                Properties

                handleSubmit: ((scrRef) => void)

                Type declaration

                  • (scrRef): void
                  • Parameters

                    • scrRef: ScriptureReference

                    Returns void

                id?: string
                scrRef: ScriptureReference
                \ No newline at end of file diff --git a/platform-bible-react/interfaces/TableCalculatedColumn.html b/platform-bible-react/interfaces/TableCalculatedColumn.html index 3de5c31364..df1411640f 100644 --- a/platform-bible-react/interfaces/TableCalculatedColumn.html +++ b/platform-bible-react/interfaces/TableCalculatedColumn.html @@ -1,4 +1,4 @@ -TableCalculatedColumn | platform-bible-react

                Interface TableCalculatedColumn<R>

                interface TableCalculatedColumn<R> {
                    draggable: boolean;
                    editable?: null | boolean | ((row) => boolean);
                    frozen: boolean;
                    idx: number;
                    isLastFrozenColumn: boolean;
                    key: string;
                    level: number;
                    maxWidth: undefined | number;
                    minWidth: number;
                    name: string | ReactElement<any, string | JSXElementConstructor<any>>;
                    parent: undefined | TableCalculatedColumnParent<R>;
                    renderCell: ((props) => ReactNode);
                    renderEditCell?: null | ((props) => ReactNode);
                    resizable: boolean;
                    sortDescendingFirst?: null | boolean;
                    sortable: boolean;
                    width: string | number;
                }

                Type Parameters

                • R

                Hierarchy (view full)

                Properties

                draggable +TableCalculatedColumn | platform-bible-react

                Interface TableCalculatedColumn<R>

                interface TableCalculatedColumn<R> {
                    draggable: boolean;
                    editable?: null | boolean | ((row) => boolean);
                    frozen: boolean;
                    idx: number;
                    isLastFrozenColumn: boolean;
                    key: string;
                    level: number;
                    maxWidth: undefined | number;
                    minWidth: number;
                    name: string | ReactElement<any, string | JSXElementConstructor<any>>;
                    parent: undefined | TableCalculatedColumnParent<R>;
                    renderCell: ((props) => ReactNode);
                    renderEditCell?: null | ((props) => ReactNode);
                    resizable: boolean;
                    sortDescendingFirst?: null | boolean;
                    sortable: boolean;
                    width: string | number;
                }

                Type Parameters

                • R

                Hierarchy (view full)

                Properties

                draggable: boolean
                editable?: null | boolean | ((row) => boolean)

                If true, editing is enabled. If no custom cell editor is provided through renderEditCell +

                Properties

                draggable: boolean
                editable?: null | boolean | ((row) => boolean)

                If true, editing is enabled. If no custom cell editor is provided through renderEditCell the default text editor will be used for editing. Note: If editable is set to 'true' and no custom renderEditCell is provided, the internal logic that sets the renderEditCell will shallow clone the column.

                -

                Type declaration

                  • (row): boolean
                  • Parameters

                    • row: R

                    Returns boolean

                frozen: boolean
                idx: number
                isLastFrozenColumn: boolean
                key: string

                A unique key to distinguish each column

                -
                level: number
                maxWidth: undefined | number
                minWidth: number
                name: string | ReactElement<any, string | JSXElementConstructor<any>>

                The name of the column. By default it will be displayed in the header cell

                -
                parent: undefined | TableCalculatedColumnParent<R>
                renderCell: ((props) => ReactNode)

                Type declaration

                  • (props): ReactNode
                  • Parameters

                    • props: RenderCellProps<R, unknown>

                    Returns ReactNode

                renderEditCell?: null | ((props) => ReactNode)

                Editor to be rendered when cell of column is being edited. Don't forget to also set the +

                Type declaration

                  • (row): boolean
                  • Parameters

                    • row: R

                    Returns boolean

                frozen: boolean
                idx: number
                isLastFrozenColumn: boolean
                key: string

                A unique key to distinguish each column

                +
                level: number
                maxWidth: undefined | number
                minWidth: number
                name: string | ReactElement<any, string | JSXElementConstructor<any>>

                The name of the column. By default it will be displayed in the header cell

                +
                parent: undefined | TableCalculatedColumnParent<R>
                renderCell: ((props) => ReactNode)

                Type declaration

                  • (props): ReactNode
                  • Parameters

                    • props: RenderCellProps<R, unknown>

                    Returns ReactNode

                renderEditCell?: null | ((props) => ReactNode)

                Editor to be rendered when cell of column is being edited. Don't forget to also set the editable prop to true in order to enable editing.

                -

                Type declaration

                resizable: boolean
                sortDescendingFirst?: null | boolean

                Sets the column sort order to be descending instead of ascending the first time the column is +

                Type declaration

                resizable: boolean
                sortDescendingFirst?: null | boolean

                Sets the column sort order to be descending instead of ascending the first time the column is sorted

                -
                sortable: boolean
                width: string | number
                \ No newline at end of file +
                sortable: boolean
                width: string | number
                \ No newline at end of file diff --git a/platform-bible-react/types/AnchorOrigin.html b/platform-bible-react/types/AnchorOrigin.html index 9dc457cd85..075d4dc929 100644 --- a/platform-bible-react/types/AnchorOrigin.html +++ b/platform-bible-react/types/AnchorOrigin.html @@ -1 +1 @@ -AnchorOrigin | platform-bible-react
                \ No newline at end of file +AnchorOrigin | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 1934763478..399dea4499 100644 --- a/platform-bible-react/types/ChapterRangeSelectorProps.html +++ b/platform-bible-react/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | platform-bible-react

                Type alias ChapterRangeSelectorProps

                ChapterRangeSelectorProps: {
                    chapterCount: number;
                    handleSelectEndChapter: ((chapter) => void);
                    handleSelectStartChapter: ((chapter) => void);
                    isDisabled?: boolean;
                }

                Type declaration

                • chapterCount: number
                • handleSelectEndChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • handleSelectStartChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • Optional isDisabled?: boolean
                \ No newline at end of file +ChapterRangeSelectorProps | platform-bible-react

                Type alias ChapterRangeSelectorProps

                ChapterRangeSelectorProps: {
                    chapterCount: number;
                    handleSelectEndChapter: ((chapter) => void);
                    handleSelectStartChapter: ((chapter) => void);
                    isDisabled?: boolean;
                }

                Type declaration

                • chapterCount: number
                • handleSelectEndChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • handleSelectStartChapter: ((chapter) => void)
                    • (chapter): void
                    • Parameters

                      • chapter: number

                      Returns void

                • Optional isDisabled?: boolean
                \ No newline at end of file diff --git a/platform-bible-react/types/CheckboxProps.html b/platform-bible-react/types/CheckboxProps.html index c07ca93e9d..907e4334b0 100644 --- a/platform-bible-react/types/CheckboxProps.html +++ b/platform-bible-react/types/CheckboxProps.html @@ -21,4 +21,4 @@
                  • (event): void
                  • Parameters

                    • event: ChangeEvent<HTMLInputElement>

                      The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).

                      -

                    Returns void

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/ChecklistProps.html b/platform-bible-react/types/ChecklistProps.html index ed69c364bc..1f79407f6f 100644 --- a/platform-bible-react/types/ChecklistProps.html +++ b/platform-bible-react/types/ChecklistProps.html @@ -6,4 +6,4 @@
              • Optional legend?: string

                Optional string representing legend for fieldset element

              • listItems: string[]

                Array of strings representing the legend text for the fieldset element

              • selectedListItems: string[]

                Array of strings representing items to be displayed as checkboxes in the checklist

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/CloseReason.html b/platform-bible-react/types/CloseReason.html index 9294ac434e..60ed0a5a3b 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
                \ No newline at end of file +CloseReason | platform-bible-react

                Type alias CloseReason

                CloseReason: SnackbarCloseReason
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeDetails.html b/platform-bible-react/types/ComboBoxChangeDetails.html index 4bfe24f435..96342a342c 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
                \ No newline at end of file +ComboBoxChangeDetails | platform-bible-react

                Type alias ComboBoxChangeDetails<T>

                ComboBoxChangeDetails<T>: AutocompleteChangeDetails<T>

                Type Parameters

                • T
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxChangeReason.html b/platform-bible-react/types/ComboBoxChangeReason.html index 9fbdfef9ef..2770628a78 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
                \ No newline at end of file +ComboBoxChangeReason | platform-bible-react

                Type alias ComboBoxChangeReason

                ComboBoxChangeReason: AutocompleteChangeReason
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index de613f3163..84674435d1 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
                \ No newline at end of file +ComboBoxLabelOption | platform-bible-react

                Type alias ComboBoxLabelOption

                ComboBoxLabelOption: {
                    label: string;
                }

                Type declaration

                • label: string
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index e6601be3c2..0b432fdcdb 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react
                \ No newline at end of file +ComboBoxOption | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index 891e809c0f..72cea5fc01 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -21,4 +21,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

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ComboBoxValue.html b/platform-bible-react/types/ComboBoxValue.html index 0f40703a38..b37813ee1e 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
                \ 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
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html index dea8f882e3..5f52d4ad63 100644 --- a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html +++ b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html @@ -1 +1 @@ -DropdownMenuCheckboxItemProps | platform-bible-react

                Type alias DropdownMenuCheckboxItemProps

                DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
                    checked?: boolean;
                    className?: string;
                }

                Type declaration

                • Optional checked?: boolean
                • Optional className?: string
                \ No newline at end of file +DropdownMenuCheckboxItemProps | platform-bible-react

                Type alias DropdownMenuCheckboxItemProps

                DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
                    checked?: boolean;
                    className?: string;
                }

                Type declaration

                • Optional checked?: boolean
                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuContentProps.html b/platform-bible-react/types/DropdownMenuContentProps.html index f44b651f39..830e5b1d61 100644 --- a/platform-bible-react/types/DropdownMenuContentProps.html +++ b/platform-bible-react/types/DropdownMenuContentProps.html @@ -1 +1 @@ -DropdownMenuContentProps | platform-bible-react

                Type alias DropdownMenuContentProps

                DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
                    className?: string;
                    sideOffset?: number;
                }

                Type declaration

                • Optional className?: string
                • Optional sideOffset?: number
                \ No newline at end of file +DropdownMenuContentProps | platform-bible-react

                Type alias DropdownMenuContentProps

                DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
                    className?: string;
                    sideOffset?: number;
                }

                Type declaration

                • Optional className?: string
                • Optional sideOffset?: number
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuItemProps.html b/platform-bible-react/types/DropdownMenuItemProps.html index 91b99fdedd..85cbf50991 100644 --- a/platform-bible-react/types/DropdownMenuItemProps.html +++ b/platform-bible-react/types/DropdownMenuItemProps.html @@ -1 +1 @@ -DropdownMenuItemProps | platform-bible-react

                Type alias DropdownMenuItemProps

                DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file +DropdownMenuItemProps | platform-bible-react

                Type alias DropdownMenuItemProps

                DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuLabelProps.html b/platform-bible-react/types/DropdownMenuLabelProps.html index fd42998f50..566ff07a84 100644 --- a/platform-bible-react/types/DropdownMenuLabelProps.html +++ b/platform-bible-react/types/DropdownMenuLabelProps.html @@ -1 +1 @@ -DropdownMenuLabelProps | platform-bible-react

                Type alias DropdownMenuLabelProps

                DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file +DropdownMenuLabelProps | platform-bible-react

                Type alias DropdownMenuLabelProps

                DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuRadioItemProps.html b/platform-bible-react/types/DropdownMenuRadioItemProps.html index bdd8c2a33a..c21a3011a6 100644 --- a/platform-bible-react/types/DropdownMenuRadioItemProps.html +++ b/platform-bible-react/types/DropdownMenuRadioItemProps.html @@ -1 +1 @@ -DropdownMenuRadioItemProps | platform-bible-react

                Type alias DropdownMenuRadioItemProps

                DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file +DropdownMenuRadioItemProps | platform-bible-react

                Type alias DropdownMenuRadioItemProps

                DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSeparatorProps.html b/platform-bible-react/types/DropdownMenuSeparatorProps.html index 2e0d9d2b16..d1094e4bb5 100644 --- a/platform-bible-react/types/DropdownMenuSeparatorProps.html +++ b/platform-bible-react/types/DropdownMenuSeparatorProps.html @@ -1 +1 @@ -DropdownMenuSeparatorProps | platform-bible-react

                Type alias DropdownMenuSeparatorProps

                DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file +DropdownMenuSeparatorProps | platform-bible-react

                Type alias DropdownMenuSeparatorProps

                DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuShortcutProps.html b/platform-bible-react/types/DropdownMenuShortcutProps.html index e4df6d93cc..e1146ede6c 100644 --- a/platform-bible-react/types/DropdownMenuShortcutProps.html +++ b/platform-bible-react/types/DropdownMenuShortcutProps.html @@ -1 +1 @@ -DropdownMenuShortcutProps | platform-bible-react

                Type alias DropdownMenuShortcutProps

                DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file +DropdownMenuShortcutProps | platform-bible-react

                Type alias DropdownMenuShortcutProps

                DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSubContentProps.html b/platform-bible-react/types/DropdownMenuSubContentProps.html index 0a3173ff63..cfe83bbeaa 100644 --- a/platform-bible-react/types/DropdownMenuSubContentProps.html +++ b/platform-bible-react/types/DropdownMenuSubContentProps.html @@ -1 +1 @@ -DropdownMenuSubContentProps | platform-bible-react

                Type alias DropdownMenuSubContentProps

                DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file +DropdownMenuSubContentProps | platform-bible-react

                Type alias DropdownMenuSubContentProps

                DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
                    className?: string;
                }

                Type declaration

                • Optional className?: string
                \ No newline at end of file diff --git a/platform-bible-react/types/DropdownMenuSubTriggerProps.html b/platform-bible-react/types/DropdownMenuSubTriggerProps.html index 6c78ab445b..9e3fe43a0f 100644 --- a/platform-bible-react/types/DropdownMenuSubTriggerProps.html +++ b/platform-bible-react/types/DropdownMenuSubTriggerProps.html @@ -1 +1 @@ -DropdownMenuSubTriggerProps | platform-bible-react

                Type alias DropdownMenuSubTriggerProps

                DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file +DropdownMenuSubTriggerProps | platform-bible-react

                Type alias DropdownMenuSubTriggerProps

                DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
                    className?: string;
                    inset?: boolean;
                }

                Type declaration

                • Optional className?: string
                • Optional inset?: boolean
                \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index 06a2310676..dfd9299ba4 100644 --- a/platform-bible-react/types/GridMenuInfo.html +++ b/platform-bible-react/types/GridMenuInfo.html @@ -1,2 +1,2 @@ GridMenuInfo | platform-bible-react

                Type alias GridMenuInfo

                GridMenuInfo: {
                    multiColumnMenu: Localized<MultiColumnMenu>;
                }

                Type declaration

                • multiColumnMenu: Localized<MultiColumnMenu>

                  The menu object containing information about the columns, groups, and items to display.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index d0234af2c2..ab26607156 100644 --- a/platform-bible-react/types/GridMenuProps.html +++ b/platform-bible-react/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | platform-bible-react

                Type alias GridMenuProps

                GridMenuProps: GridMenuInfo & {
                    className?: string;
                    commandHandler: CommandHandler;
                    id?: string;
                }

                Type declaration

                • Optional className?: string

                  Additional css classes to help with unique styling of the grid menu

                • commandHandler: CommandHandler
                • Optional id?: string

                  Optional unique identifier

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index d3afc16321..8c13eefd7e 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.

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index 9bf3cadfba..b3a8884f0c 100644 --- a/platform-bible-react/types/MenuItemListProps.html +++ b/platform-bible-react/types/MenuItemListProps.html @@ -1,2 +1,2 @@ MenuItemListProps | platform-bible-react

                Type alias MenuItemListProps

                MenuItemListProps: MenuPropsBase & {
                    columnId?: ReferencedItem;
                }

                Type declaration

                • Optional columnId?: ReferencedItem

                  Optional unique (column) identifier

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index f3489962e0..b8625aa06f 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -1,4 +1,4 @@ SearchBarProps | platform-bible-react

                Type alias SearchBarProps

                SearchBarProps: {
                    isFullWidth?: boolean;
                    onSearch: ((searchQuery) => void);
                    placeholder?: string;
                }

                Type declaration

                • Optional isFullWidth?: boolean

                  Optional boolean to set the input base to full width

                • onSearch: ((searchQuery) => void)

                  Callback fired to handle the search query when button pressed

                    • (searchQuery): void
                    • Parameters

                      • searchQuery: string

                      Returns void

                • Optional placeholder?: string

                  Optional string that appears in the search bar without a search string

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/SliderProps.html b/platform-bible-react/types/SliderProps.html index ffaaca1beb..be4737cf47 100644 --- a/platform-bible-react/types/SliderProps.html +++ b/platform-bible-react/types/SliderProps.html @@ -40,4 +40,4 @@

                Default

                'off'
                 
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarContentProps.html b/platform-bible-react/types/SnackbarContentProps.html index f264ff0119..4806e01c32 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/SnackbarProps.html b/platform-bible-react/types/SnackbarProps.html index 90b27d563e..220b5674a2 100644 --- a/platform-bible-react/types/SnackbarProps.html +++ b/platform-bible-react/types/SnackbarProps.html @@ -12,4 +12,4 @@
              • Optional onClose?: ((event, reason) => void)

                Optional, used to control the open prop event: Event | SyntheticEvent<Element, Event>, reason: string

                -
                  • (event, reason): void
                  • Parameters

                    • event: Event | SyntheticEvent<Element, Event>
                    • reason: CloseReason

                    Returns void

              • \ No newline at end of file +
                  • (event, reason): void
                  • Parameters

                    • event: Event | SyntheticEvent<Element, Event>
                    • reason: CloseReason

                    Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/SwitchProps.html b/platform-bible-react/types/SwitchProps.html index 472c5be065..c7fee759a7 100644 --- a/platform-bible-react/types/SwitchProps.html +++ b/platform-bible-react/types/SwitchProps.html @@ -11,4 +11,4 @@
                  • (event): void
                  • Parameters

                    • event: ChangeEvent<HTMLInputElement>

                      The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).

                      -

                    Returns void

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-react/types/TableCellClickArgs.html b/platform-bible-react/types/TableCellClickArgs.html index 20b519e21b..0c779c3a6b 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
                \ No newline at end of file +TableCellClickArgs | platform-bible-react

                Type alias TableCellClickArgs<R>

                TableCellClickArgs<R>: CellClickArgs<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyDownArgs.html b/platform-bible-react/types/TableCellKeyDownArgs.html index c26894e923..c77702b0f2 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
                \ No newline at end of file +TableCellKeyDownArgs | platform-bible-react

                Type alias TableCellKeyDownArgs<R>

                TableCellKeyDownArgs<R>: CellKeyDownArgs<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableCellKeyboardEvent.html b/platform-bible-react/types/TableCellKeyboardEvent.html index 711e44e744..0d8921700e 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
                \ No newline at end of file +TableCellKeyboardEvent | platform-bible-react

                Type alias TableCellKeyboardEvent

                TableCellKeyboardEvent: CellKeyboardEvent
                \ No newline at end of file diff --git a/platform-bible-react/types/TableCellMouseEvent.html b/platform-bible-react/types/TableCellMouseEvent.html index fea93d0228..ec2bf84274 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
                \ No newline at end of file +TableCellMouseEvent | platform-bible-react

                Type alias TableCellMouseEvent

                TableCellMouseEvent: CellMouseEvent
                \ No newline at end of file diff --git a/platform-bible-react/types/TableColumn.html b/platform-bible-react/types/TableColumn.html index 4860dcc38e..50976545d1 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

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/TableCopyEvent.html b/platform-bible-react/types/TableCopyEvent.html index 0cac912c4d..d3a993d644 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
                \ No newline at end of file +TableCopyEvent | platform-bible-react

                Type alias TableCopyEvent<R>

                TableCopyEvent<R>: CopyEvent<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableEditorProps.html b/platform-bible-react/types/TableEditorProps.html index 0fc96ce55d..2c6aac478d 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
                \ 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
                \ No newline at end of file diff --git a/platform-bible-react/types/TablePasteEvent.html b/platform-bible-react/types/TablePasteEvent.html index eff8cadc0a..047096ffa9 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
                \ No newline at end of file +TablePasteEvent | platform-bible-react

                Type alias TablePasteEvent<R>

                TablePasteEvent<R>: PasteEvent<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableProps.html b/platform-bible-react/types/TableProps.html index db175c4aab..ea1dcd46ee 100644 --- a/platform-bible-react/types/TableProps.html +++ b/platform-bible-react/types/TableProps.html @@ -52,4 +52,4 @@
              • 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

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/TableRowsChangeData.html b/platform-bible-react/types/TableRowsChangeData.html index c39d32651d..9528662293 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
                \ No newline at end of file +TableRowsChangeData | platform-bible-react

                Type alias TableRowsChangeData<R>

                TableRowsChangeData<R>: RowsChangeData<R>

                Type Parameters

                • R
                \ No newline at end of file diff --git a/platform-bible-react/types/TableSortColumn.html b/platform-bible-react/types/TableSortColumn.html index 283e0554ac..24eb2c5ac0 100644 --- a/platform-bible-react/types/TableSortColumn.html +++ b/platform-bible-react/types/TableSortColumn.html @@ -1 +1 @@ -TableSortColumn | platform-bible-react
                \ No newline at end of file +TableSortColumn | platform-bible-react
                \ No newline at end of file diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index a5c9112532..283989d717 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -20,4 +20,4 @@
              • Optional onFocus?: FocusEventHandler<HTMLInputElement>

                Triggers when textfield gets focus

              • Optional placeholder?: string

                The short hint displayed in the input before the user enters a value.

              • Optional value?: string | number

                Value of the text field if controlled

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index 102ad947d2..b201d3505c 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
              • Optional id?: string

                Optional unique identifier

              • Optional menuProvider?: MultiColumnMenuProvider

                The optional delegate to use to get the menu data. If not specified, the "hamburger" menu will not display.

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index 7f7767cbd4..bee8a91a66 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index 511678e380..fafe6e16e9 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. Defaults to 10000 ms

                -
              • Returns AsyncVariable<T>

                Properties

                promiseToValue: Promise<T>
                rejecter: undefined | ((reason) => void)

                Type declaration

                  • (reason): void
                  • Parameters

                    • reason: undefined | string

                    Returns void

                resolver: undefined | ((value) => void)

                Type declaration

                  • (value): void
                  • Parameters

                    • value: T

                    Returns void

                variableName: string

                Accessors

                • get hasSettled(): boolean
                • A simple way to see if this variable's promise was resolved or rejected already

                  +

                Returns AsyncVariable<T>

                Properties

                promiseToValue: Promise<T>
                rejecter: undefined | ((reason) => void)

                Type declaration

                  • (reason): void
                  • Parameters

                    • reason: undefined | string

                    Returns void

                resolver: undefined | ((value) => void)

                Type declaration

                  • (value): void
                  • Parameters

                    • value: T

                    Returns void

                variableName: string

                Accessors

                • get promise(): Promise<T>
                • Get this variable's promise to a value. This always returns the same promise even after the value has been resolved or rejected.

                  Returns Promise<T>

                  The promise for the value to be set

                  -

                Methods

                Methods

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

                  Parameters

                  • reason: string

                    This variable's promise will be rejected with this reason

                  • throwIfAlreadySettled: boolean = false

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

                    -

                  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. Defaults to false

                    -

                  Returns void

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/classes/Collator.html b/platform-bible-utils/classes/Collator.html index 2017eb35d6..93d76b568a 100644 --- a/platform-bible-utils/classes/Collator.html +++ b/platform-bible-utils/classes/Collator.html @@ -1,15 +1,15 @@ Collator | platform-bible-utils

                Enables language-sensitive string comparison. Wraps Intl.Collator

                -

                Constructors

                Constructors

                Properties

                Methods

                Constructors

                Properties

                collator: Collator

                Methods

                • Compares two strings according to the sort order of this Collator object

                  +

                Constructors

                Properties

                collator: Collator

                Methods

                • Compares two strings according to the sort order of this Collator object

                  Parameters

                  • string1: string

                    String to compare

                  • string2: string

                    String to compare

                  Returns number

                  A number indicating how string1 and string2 compare to each other according to the sort order of this Collator object. Negative value if string1 comes before string2. Positive value if string1 comes after string2. 0 if they are considered equal.

                  -
                • Returns a new object with properties reflecting the locale and collation options computed during initialization of this collator object.

                  Returns ResolvedCollatorOptions

                  ResolvedCollatorOptions object

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/classes/DateTimeFormat.html b/platform-bible-utils/classes/DateTimeFormat.html index ed5f6f2663..8c00549bcb 100644 --- a/platform-bible-utils/classes/DateTimeFormat.html +++ b/platform-bible-utils/classes/DateTimeFormat.html @@ -1,30 +1,30 @@ DateTimeFormat | platform-bible-utils

                Enables language-sensitive data and time formatting. Wraps Intl.DateTimeFormat

                -

                Constructors

                Constructors

                Properties

                dateTimeFormatter: DateTimeFormat

                Methods

                • Formats a date according to the locale and formatting option for this DateTimeFormat object

                  +

                Constructors

                Properties

                dateTimeFormatter: DateTimeFormat

                Methods

                • Formats a date according to the locale and formatting option for this DateTimeFormat object

                  Parameters

                  • date: Date

                    The date to format

                  Returns string

                  String representing the given date formatted according to the locale and formatting options of this DateTimeFormat object

                  -
                • Formats a date range in the most concise way based on the locales and options provided when instantiating this DateTimeFormat object

                  Parameters

                  • startDate: Date

                    Date object representing start of the date range

                  • endDate: Date

                    Date object representing the end of the date range

                  Returns string

                  String representing the given date range formatted according to the locale and formatting options of this DateTimeFormat object

                  -
                • Returns an array of locale-specific tokens representing each part of the formatted date range produced by this DateTimeFormat object

                  Parameters

                  • startDate: Date

                    Date object representing start of the date range

                  • endDate: Date

                    Date object representing the end of the date range

                  Returns DateTimeRangeFormatPart[]

                  Array of DateTimeRangeFormatPart objects

                  -
                • Allows locale-aware formatting of strings produced by this DateTimeFormat object

                  Parameters

                  • date: Date

                    The date to format

                  Returns DateTimeFormatPart[]

                  Array of DateTimeFormatPart objects

                  -
                • Returns a new object with properties reflecting the locale and date and time formatting options computed during initialization of this DateTimeFormat object

                  Returns ResolvedDateTimeFormatOptions

                  ResolvedDateTimeFormatOptions object

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index 331bafb695..ba8b2cbc77 100644 --- a/platform-bible-utils/classes/DocumentCombiner.html +++ b/platform-bible-utils/classes/DocumentCombiner.html @@ -1,6 +1,6 @@ DocumentCombiner | platform-bible-utils

                Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

                -

                Hierarchy (view full)

                Constructors

                Hierarchy (view full)

                Constructors

                Properties

                Constructors

                Properties

                baseDocument: JsonDocumentLike
                contributions: Map<string, JsonDocumentLike> = ...
                latestOutput: undefined | JsonDocumentLike
                onDidRebuild: PlatformEvent<undefined> = ...

                Event that emits to announce that the document has been rebuilt and the output has been updated

                -
                onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

                Methods

                • Add or update one of the contribution documents for the composition process

                  +

                Returns DocumentCombiner

                Properties

                baseDocument: JsonDocumentLike
                contributions: Map<string, JsonDocumentLike> = ...
                latestOutput: undefined | JsonDocumentLike
                onDidRebuild: PlatformEvent<undefined> = ...

                Event that emits to announce that the document has been rebuilt and the output has been updated

                +
                onDidRebuildEmitter: PlatformEventEmitter<undefined> = ...

                Methods

                • Add or update one of the contribution documents for the composition process

                  Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -33,22 +33,22 @@

                • document: JsonDocumentLike

                  Content of the contributed document to combine

                Returns undefined | JsonDocumentLike

                Recalculated output document given the new or updated contribution and existing other documents

                -
                • Transform the starting document that is given to the combiner. This transformation occurs after validating the base document and before combining any contributions.

                  WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the baseDocument passed in.

                  Parameters

                  • baseDocument: JsonDocumentLike

                    Initial input document. Already validated via validateBaseDocument

                  Returns JsonDocumentLike

                  Transformed base document

                  -
                • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

                  WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

                  @@ -56,19 +56,19 @@
                • document: JsonDocumentLike

                  Content of the contributed document to combine. Already validated via validateContribution

                Returns JsonDocumentLike

                Transformed contributed document

                -
                • Transform the document that is the composition of the base document and all contribution documents. This is the last step that will be run prior to validation via validateOutput before this.latestOutput is updated to the new output.

                  Parameters

                  • finalOutput: JsonDocumentLike

                    Final output document that could potentially be returned to callers. "Final" means no further contribution documents will be merged.

                    -

                  Returns JsonDocumentLike

                • Update the starting document for composition process

                  +

                Returns JsonDocumentLike

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

                  +

                Returns void

                • Throw an error if the provided 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

                \ No newline at end of file +

                Returns void

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

                Example

                const mutex = new Mutex();

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

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

                See async-mutex for more information.

                -

                Hierarchy

                • Mutex
                  • Mutex

                Constructors

                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 57ed83aff9..c5f330688b 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

                \ No newline at end of file +

                Constructors

                Properties

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

                Methods

                \ No newline at end of file diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index ada575471d..7f9cb887aa 100644 --- a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html +++ b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html @@ -1,6 +1,6 @@ NonValidatingDocumentCombiner | platform-bible-utils

                Class NonValidatingDocumentCombiner

                Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

                -

                Hierarchy (view full)

                Constructors

                Hierarchy (view full)

                Constructors

                Properties

                baseDocument: JsonDocumentLike
                contributions: Map<string, JsonDocumentLike> = ...
                latestOutput: undefined | JsonDocumentLike
                onDidRebuild: PlatformEvent<undefined> = ...

                Event that emits to announce that the document has been rebuilt and the output has been updated

                -

                Accessors

                Methods

                • Add or update one of the contribution documents for the composition process

                  +

                Constructors

                Properties

                baseDocument: JsonDocumentLike
                contributions: Map<string, JsonDocumentLike> = ...
                latestOutput: undefined | JsonDocumentLike
                onDidRebuild: PlatformEvent<undefined> = ...

                Event that emits to announce that the document has been rebuilt and the output has been updated

                +

                Accessors

                Methods

                • Add or update one of the contribution documents for the composition process

                  Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is @@ -30,22 +30,22 @@

                • document: JsonDocumentLike

                  Content of the contributed document to combine

                Returns undefined | JsonDocumentLike

                Recalculated output document given the new or updated contribution and existing other documents

                -
                • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

                  WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

                  @@ -53,19 +53,19 @@
                • document: JsonDocumentLike

                  Content of the contributed document to combine. Already validated via validateContribution

                Returns JsonDocumentLike

                Transformed contributed document

                -
                • Update the starting document for composition process

                  +

                Returns JsonDocumentLike

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

                  +

                Returns void

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

                  +

                Returns void

                \ No newline at end of file +

                Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/classes/NumberFormat.html b/platform-bible-utils/classes/NumberFormat.html index 5e19b3475c..964035276a 100644 --- a/platform-bible-utils/classes/NumberFormat.html +++ b/platform-bible-utils/classes/NumberFormat.html @@ -1,31 +1,31 @@ NumberFormat | platform-bible-utils

                Enables language-sensitive number formatting. Wraps Intl.NumberFormat

                -

                Constructors

                Constructors

                Properties

                numberFormatter: NumberFormat

                Methods

                • Formats a number according to the locale and formatting options of this NumberFormat object

                  +

                Constructors

                Properties

                numberFormatter: NumberFormat

                Methods

                • Formats a number according to the locale and formatting options of this NumberFormat object

                  Parameters

                  • value: number | bigint

                    Number or BigInt to format

                  Returns string

                  String representing the given number formatted according to the locale and formatting options of this NumberFormat object

                  -
                • Formats a range of numbers according to the locale and formatting options of this NumberFormat object

                  Parameters

                  • startRange: number | bigint

                    Number or bigint representing the start of the range

                  • endRange: number | bigint

                    Number or bigint representing the end of the range

                  Returns string

                  String representing the given range of numbers formatted according to the locale and formatting options of this NumberFormat object

                  -
                • Returns an array of objects containing the locale-specific tokens from which it is possible to build custom strings while preserving the locale-specific parts.

                  Parameters

                  • startRange: number | bigint

                    Number or bigint representing start of the range

                  • endRange: number | bigint

                    Number or bigint representing end of the range

                  Returns NumberRangeFormatPart[]

                  Array of NumberRangeFormatPart objects containing the formatted range of numbers in parts

                  -
                • Allows locale-aware formatting of strings produced by this NumberFormat object

                  Parameters

                  • value: number | bigint

                    Number or bigint to format

                  Returns NumberFormatPart[]

                  Array of NumberFormatPart objects containing the formatted number in parts

                  -
                • Returns a new object with properties reflecting the locale and number formatting options computed during initialization of this NumberFormat object

                  Returns ResolvedNumberFormatOptions

                  ResolvedNumberFormatOptions object

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index 0c4478cad6..934827ccce 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

                Methods

                Methods

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

                Returns void

                \ No newline at end of file +

                Parameters

                • event: T

                Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index 54e8ab9d8b..dc6abace3a 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

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index c3899d1f17..b5b0aa03f9 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

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index f4f08c96af..3e23b9a328 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

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index 645ae39e2c..fadfec1db8 100644 --- a/platform-bible-utils/functions/at.html +++ b/platform-bible-utils/functions/at.html @@ -6,4 +6,4 @@ length(string)

                Returns string | undefined

                New string consisting of the Unicode code point located at the specified offset, undefined if index is out of bounds

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index 9e363db4c2..cef6ee3ae6 100644 --- a/platform-bible-utils/functions/charAt.html +++ b/platform-bible-utils/functions/charAt.html @@ -6,4 +6,4 @@ length(string)-1

                Returns string

                New string consisting of the Unicode code point located at the specified offset, empty string if index is out of bounds

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index 0c558601ed..1acfe55da5 100644 --- a/platform-bible-utils/functions/codePointAt.html +++ b/platform-bible-utils/functions/codePointAt.html @@ -7,4 +7,4 @@ length(string)-1

                Returns number | undefined

                Non-negative integer representing the code point value of the character at the given index, or undefined if there is no element at that position

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index 35ade372c4..267df9a9c2 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index 6a50c028ca..69745741c1 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index 781215b4e6..809e33eaf2 100644 --- a/platform-bible-utils/functions/deepClone.html +++ b/platform-bible-utils/functions/deepClone.html @@ -2,4 +2,4 @@ references between the source and target of property copying operations.

                Type Parameters

                • T

                Parameters

                • obj: T

                  Object to clone

                Returns T

                Duplicate copy of obj without any references back to the original one

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index 2386f0ee30..96d19c3d2e 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index 877e385de2..597c0d40e4 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

                \ No newline at end of file +

                Returns any

                \ No newline at end of file diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index 13f0d9241d..9baec7c703 100644 --- a/platform-bible-utils/functions/endsWith.html +++ b/platform-bible-utils/functions/endsWith.html @@ -6,4 +6,4 @@
              • endPosition: number = ...

                End position where searchString is expected to be found. Default is length(string)

              • Returns boolean

                True if it ends with searchString, false if it does not

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/escapeStringRegexp.html b/platform-bible-utils/functions/escapeStringRegexp.html index 0be06491c2..8c116fd122 100644 --- a/platform-bible-utils/functions/escapeStringRegexp.html +++ b/platform-bible-utils/functions/escapeStringRegexp.html @@ -5,4 +5,4 @@ function is simply copied directly from there to allow a common js export

                Parameters

                • string: string

                Returns string

                Example

                import escapeStringRegexp from 'platform-bible-utils';

                const escapedString = escapeStringRegexp('How much $ for a 🦄?');
                //=> 'How much \\$ for a 🦄\\?'

                new RegExp(escapedString);
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/formatReplacementString.html b/platform-bible-utils/functions/formatReplacementString.html index e62e250ebb..0a0f485342 100644 --- a/platform-bible-utils/functions/formatReplacementString.html +++ b/platform-bible-utils/functions/formatReplacementString.html @@ -7,4 +7,4 @@ 'name': 'Jim'}) would return 'I am Nemo'.

                Parameters

                • str: string

                  String to format

                • replacers: {
                      [key: string]: string;
                  }
                  • [key: string]: string

                Returns string

                Formatted string

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index 636eaed680..5641118ad9 100644 --- a/platform-bible-utils/functions/getAllObjectFunctionNames.html +++ b/platform-bible-utils/functions/getAllObjectFunctionNames.html @@ -5,4 +5,4 @@

                Parameters

                • obj: {
                      [property: string]: unknown;
                  }

                  Object whose functions to get

                  • [property: string]: unknown
                • objId: string = 'obj'

                  Optional ID of the object to use for debug logging

                Returns Set<string>

                Array of all function names on an object

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index 5a810f4ad3..7abf0f0a12 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

                Function getChaptersForBook

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

                Function getChaptersForBook

                \ No newline at end of file diff --git a/platform-bible-utils/functions/getCurrentLocale.html b/platform-bible-utils/functions/getCurrentLocale.html index b91901a4d8..cd7c58c73c 100644 --- a/platform-bible-utils/functions/getCurrentLocale.html +++ b/platform-bible-utils/functions/getCurrentLocale.html @@ -1,4 +1,4 @@ getCurrentLocale | platform-bible-utils

                Function getCurrentLocale

                • Retrieves the current locale of the user's environment.

                  Returns string

                  A string representing the current locale. If the locale cannot be determined, the function returns an empty string.

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 74fc8ff002..aa1d05e459 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)) }`
                 
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index d2ce857043..056b3d92bd 100644 --- a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html +++ b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html @@ -6,4 +6,4 @@

                Parameters

                • bookNumber: number
                • localizationLanguage: string

                  In BCP 47 format

                • getLocalizedString: ((item) => Promise<string>)

                  Function that provides the localized versions of the book ids and names asynchronously.

                  -
                    • (item): Promise<string>
                    • Parameters

                      • item: {
                            languagesToSearch?: string[];
                            localizeKey: string;
                        }
                        • Optional languagesToSearch?: string[]
                        • localizeKey: string

                      Returns Promise<string>

                Returns Promise<string>

                \ No newline at end of file +

                Returns Promise<string>

                \ No newline at end of file diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index ad1ec720d4..4f99f545a0 100644 --- a/platform-bible-utils/functions/groupBy.html +++ b/platform-bible-utils/functions/groupBy.html @@ -2,4 +2,4 @@

                Type Parameters

                • T
                • K

                Parameters

                • items: T[]

                  Array of items to group by

                • keySelector: ((item) => K)

                  Function to run on each item to get the key for the group to which it belongs

                    • (item): K
                    • Parameters

                      • item: T

                      Returns K

                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[]>

              • \ 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[]>

              • \ No newline at end of file diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index ad4701cc2d..b2d94151b4 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index ce92778969..d4fbe4c68f 100644 --- a/platform-bible-utils/functions/includes.html +++ b/platform-bible-utils/functions/includes.html @@ -5,4 +5,4 @@
              • searchString: string

                String to search for

              • position: number = 0

                Position within the string to start searching for searchString. Default is 0

              • Returns boolean

                True if search string is found, false if it is not

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index 820fd1abd6..3f167845e2 100644 --- a/platform-bible-utils/functions/indexOf.html +++ b/platform-bible-utils/functions/indexOf.html @@ -5,4 +5,4 @@
              • searchString: string

                The string to search for

              • position: undefined | number = 0

                Start of searching. Default is 0

              • Returns number

                Index of the first occurrence of a given string

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/isLocalizeKey.html b/platform-bible-utils/functions/isLocalizeKey.html index 2a885e1d33..37abea1aa7 100644 --- a/platform-bible-utils/functions/isLocalizeKey.html +++ b/platform-bible-utils/functions/isLocalizeKey.html @@ -1,2 +1,2 @@ isLocalizeKey | platform-bible-utils

                Function isLocalizeKey

                • Determine whether the string is a LocalizeKey meant to be localized in Platform.Bible.

                  -

                  Parameters

                  • str: string

                  Returns str is `%${string}%`

                \ No newline at end of file +

                Parameters

                • str: string

                Returns str is `%${string}%`

                \ No newline at end of file diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index c51cdbf8ca..058d8bcc56 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.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index 07784ef4b7..ff793cf25d 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/isSubset.html b/platform-bible-utils/functions/isSubset.html index 277e5e6d61..10126ca077 100644 --- a/platform-bible-utils/functions/isSubset.html +++ b/platform-bible-utils/functions/isSubset.html @@ -13,4 +13,4 @@

                It is important to note that only arrays of primitives (i.e., booleans, numbers, strings) are supported. In particular, objects in arrays will not be checked for deep equality. Also, presence in an array is all this checks, not the number of times that an item appears in an array. [1, 1] is a subset of [1].

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index 38e582e01b..6977debb69 100644 --- a/platform-bible-utils/functions/lastIndexOf.html +++ b/platform-bible-utils/functions/lastIndexOf.html @@ -6,4 +6,4 @@
              • Optional position: number

                The index at which to begin searching. If omitted, the search begins at the end of the string. Default is undefined

              • Returns number

                Index of the last occurrence of searchString found, or -1 if not found.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index 5b7c562b01..c51e032211 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils
                \ No newline at end of file +

                Returns string

                \ No newline at end of file diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index bbf91df2d5..4b5f577d75 100644 --- a/platform-bible-utils/functions/normalize.html +++ b/platform-bible-utils/functions/normalize.html @@ -4,4 +4,4 @@

                Parameters

                • string: string

                  The starting string

                • form: "none" | "NFC" | "NFD" | "NFKC" | "NFKD"

                  Form specifying the Unicode Normalization Form. Default is 'NFC'

                Returns string

                A string containing the Unicode Normalization Form of the given string.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index 9a921917ab..f70539d394 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils
                \ No newline at end of file +offsetBook | platform-bible-utils
                \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index 009ee7d142..61001b5b24 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

                Function offsetChapter

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

                Function offsetChapter

                \ No newline at end of file diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index f0aeb37555..a46590c447 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils
                \ No newline at end of file +offsetVerse | platform-bible-utils
                \ No newline at end of file diff --git a/platform-bible-utils/functions/ordinalCompare.html b/platform-bible-utils/functions/ordinalCompare.html index 32dfd8c21a..c8b3e213dc 100644 --- a/platform-bible-utils/functions/ordinalCompare.html +++ b/platform-bible-utils/functions/ordinalCompare.html @@ -7,4 +7,4 @@

                Returns number

                A number indicating the result of the comparison: - Negative value if string1 precedes string2 in sorting order. - Zero if string1 and string2 are equivalent in sorting order. - Positive value if string1 follows string2 in sorting order.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index be0c6ceb95..1a1342004b 100644 --- a/platform-bible-utils/functions/padEnd.html +++ b/platform-bible-utils/functions/padEnd.html @@ -8,4 +8,4 @@
              • padString: string = ' '

                The string to pad the current string with. If padString is too long to stay within targetLength, it will be truncated. Default is " "

              • Returns string

                String with appropriate padding at the end

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index 0de8e5d638..80bf37b0b6 100644 --- a/platform-bible-utils/functions/padStart.html +++ b/platform-bible-utils/functions/padStart.html @@ -8,4 +8,4 @@
              • padString: string = ' '

                The string to pad the current string with. If padString is too long to stay within the targetLength, it will be truncated from the end. Default is " "

              • Returns string

                String with of specified targetLength with padString applied from the start

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 51ba153c69..faf2688467 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

                \ No newline at end of file +

                Returns string

                \ No newline at end of file diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index 58ed2e86ad..fef82b6b2c 100644 --- a/platform-bible-utils/functions/slice.html +++ b/platform-bible-utils/functions/slice.html @@ -6,4 +6,4 @@
              • indexStart: number

                The index of the first character to include in the returned substring.

              • Optional indexEnd: number

                The index of the first character to exclude from the returned substring.

              • Returns string

                A new string containing the extracted section of the string.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index 638cf36e27..9fa87ddd60 100644 --- a/platform-bible-utils/functions/split.html +++ b/platform-bible-utils/functions/split.html @@ -9,4 +9,4 @@ in the array.

                Returns string[]

                An array of strings, split at each point where separator occurs in the starting string. Returns undefined if separator is not found in string.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index 15a0b8b96a..d834e653a5 100644 --- a/platform-bible-utils/functions/startsWith.html +++ b/platform-bible-utils/functions/startsWith.html @@ -8,4 +8,4 @@ searchString's first character). Default is 0

                Returns boolean

                True if the given characters are found at the beginning of the string, including when searchString is an empty string; otherwise, false.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index c45f83b009..695bdbdcc5 100644 --- a/platform-bible-utils/functions/stringLength.html +++ b/platform-bible-utils/functions/stringLength.html @@ -4,4 +4,4 @@

                Returns the length of a string.

                Parameters

                • string: string

                  String to return the length for

                Returns number

                Number that is length of the starting string

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index 2a7a6ad82b..9b425216c7 100644 --- a/platform-bible-utils/functions/substring.html +++ b/platform-bible-utils/functions/substring.html @@ -5,4 +5,4 @@
              • begin: number

                Start position

              • end: number = ...

                End position. Default is End of string

              • Returns string

                Substring from starting string

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index 5bc2b03dc7..3a3eabe027 100644 --- a/platform-bible-utils/functions/toArray.html +++ b/platform-bible-utils/functions/toArray.html @@ -3,4 +3,4 @@

                Converts a string to an array of string characters.

                Parameters

                • string: string

                  String to convert to array

                Returns string[]

                An array of characters from the starting string

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index ae7414a22f..8781965a5c 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>

                \ No newline at end of file +

                Parameters

                • ms: number

                Returns Promise<void>

                \ No newline at end of file diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index 0f9d432a78..2a25b717fe 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 347a5de502..10183b3387 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
                \ No newline at end of file +

                Properties

                chapters: number
                fullNames: string[]
                shortName: string
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index 091d52b53d..6b9f6867c0 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

                -
                \ No newline at end of file +
                onDidDispose?: undefined

                Event that emits when dispose is called on an object

                +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index d672755299..d34bc75081 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/LanguageStrings.html b/platform-bible-utils/interfaces/LanguageStrings.html index 5188c486c4..245ab97fc8 100644 --- a/platform-bible-utils/interfaces/LanguageStrings.html +++ b/platform-bible-utils/interfaces/LanguageStrings.html @@ -1,3 +1,3 @@ LanguageStrings | platform-bible-utils

                Interface LanguageStrings

                Map whose keys are localized string keys and whose values provide information about how to localize strings for the localized string key

                -
                interface LanguageStrings {
                    [k: LocalizeKey]: LocalizedStringValue;
                }

                Indexable

                \ No newline at end of file +
                interface LanguageStrings {
                    [k: LocalizeKey]: LocalizedStringValue;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html index 0310529420..3529925639 100644 --- a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html +++ b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html @@ -1,4 +1,4 @@ LocalizedStringDataContribution | platform-bible-utils

                Interface LocalizedStringDataContribution

                The data an extension provides to inform Platform.Bible of the localized strings it provides.

                -
                interface LocalizedStringDataContribution {
                    localizedStrings?: {
                        [k: string]: LanguageStrings;
                    };
                    metadata?: StringsMetadata;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                interface LocalizedStringDataContribution {
                    localizedStrings?: {
                        [k: string]: LanguageStrings;
                    };
                    metadata?: StringsMetadata;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                localizedStrings?: {
                    [k: string]: LanguageStrings;
                }

                Type declaration

                metadata?: StringsMetadata
                \ No newline at end of file +

                Properties

                localizedStrings?: {
                    [k: string]: LanguageStrings;
                }

                Type declaration

                metadata?: StringsMetadata
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index b1a14907b5..ca6b4f50dc 100644 --- a/platform-bible-utils/interfaces/ModifierExtensionControlled.html +++ b/platform-bible-utils/interfaces/ModifierExtensionControlled.html @@ -1,6 +1,6 @@ ModifierExtensionControlled | platform-bible-utils

                Interface ModifierExtensionControlled

                Modifies state/setting type to be extension-controlled. "Extension-controlled" means the extension provides the component and the validator for the state/setting, so the state/setting is controlled by the extension.

                -
                interface ModifierExtensionControlled {
                    platformType?: undefined;
                    type?: undefined;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                interface ModifierExtensionControlled {
                    platformType?: undefined;
                    type?: undefined;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                Properties

                platformType?: undefined
                type?: undefined
                \ No newline at end of file +

                Properties

                platformType?: undefined
                type?: undefined
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index a1030a25bd..63a2c1c696 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,4 +1,4 @@ -ModifierProject | platform-bible-utils

                Interface ModifierProject

                interface ModifierProject {
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                }

                Properties

                excludePdpFactoryIds? +ModifierProject | platform-bible-utils

                Interface ModifierProject

                interface ModifierProject {
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                }

                Properties

                excludePdpFactoryIds? excludeProjectInterfaces? includePdpFactoryIds? includeProjectInterfaces? @@ -8,7 +8,7 @@ function) to determine if the projects should absolutely not be included even if they match with includeProjectInterfaces.

                Defaults to none, so all projects that match includePdpFactoryIds will be included

                -
                excludeProjectInterfaces?: string | (string | string[])[]

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

                excludeProjectInterfaces?: string | (string | string[])[]

                String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should absolutely not be included even if they match with @@ -35,13 +35,13 @@

              • Include one
              • Include both two and three.
              • -
                includePdpFactoryIds?: string | string[]

                String representation of RegExp pattern(s) to match against the Project Data Provider Factory +

                includePdpFactoryIds?: string | string[]

                String representation of RegExp pattern(s) to match against the Project Data Provider Factory Ids that provided each project's metadata (using the test function) to determine if the projects should be included.

                Defaults to all Project Data Provider Factory Ids, so all projects that do not match excludePdpFactoryIds will be included

                -
                includeProjectInterfaces?: string | (string | string[])[]

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

                includeProjectInterfaces?: string | (string | string[])[]

                String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included.

                @@ -67,4 +67,4 @@
              • Include one
              • Include both two and three.
              • -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 10be36379e..c2053b830e 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 736e69ab6f..83ea356bc9 100644 --- a/platform-bible-utils/interfaces/ProjectSettingProperties.html +++ b/platform-bible-utils/interfaces/ProjectSettingProperties.html @@ -1,2 +1,2 @@ ProjectSettingProperties | platform-bible-utils

                Interface ProjectSettingProperties

                Object whose keys are setting IDs and whose values are settings objects

                -
                interface ProjectSettingProperties {
                    [k: ReferencedItem]: ProjectSetting;
                }

                Indexable

                \ No newline at end of file +
                interface ProjectSettingProperties {
                    [k: ReferencedItem]: ProjectSetting;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index d8ccbb5268..eb8482a8e4 100644 --- a/platform-bible-utils/interfaces/ProjectSettingsGroup.html +++ b/platform-bible-utils/interfaces/ProjectSettingsGroup.html @@ -1,7 +1,7 @@ ProjectSettingsGroup | platform-bible-utils

                Interface ProjectSettingsGroup

                Group of related settings definitions

                -
                interface ProjectSettingsGroup {
                    description?: `%${string}%`;
                    label: `%${string}%`;
                    properties: ProjectSettingProperties;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                interface ProjectSettingsGroup {
                    description?: `%${string}%`;
                    label: `%${string}%`;
                    properties: ProjectSettingProperties;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                description?: `%${string}%`

                LocalizeKey that displays in the project settings dialog to describe the group

                -
                label: `%${string}%`

                LocalizeKey that displays in the project settings dialog as the group name

                -
                \ No newline at end of file +
                label: `%${string}%`

                LocalizeKey that displays in the project settings dialog as the group name

                +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 13b8476c73..596c584857 100644 --- a/platform-bible-utils/interfaces/ProjectStateContribution.html +++ b/platform-bible-utils/interfaces/ProjectStateContribution.html @@ -1,2 +1,2 @@ ProjectStateContribution | platform-bible-utils

                Interface ProjectStateContribution

                The data an extension provides to inform Platform.Bible of the project state it provides

                -
                interface ProjectStateContribution {
                    [k: ReferencedItem]: UserState;
                }

                Indexable

                \ No newline at end of file +
                interface ProjectStateContribution {
                    [k: ReferencedItem]: UserState;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index d38bc681c7..ab05ad111a 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
                \ No newline at end of file +

                Properties

                bookNum: number
                chapterNum: number
                verseNum: number
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index 355c1899e8..84b05f4a2b 100644 --- a/platform-bible-utils/interfaces/SettingProperties.html +++ b/platform-bible-utils/interfaces/SettingProperties.html @@ -1,2 +1,2 @@ SettingProperties | platform-bible-utils

                Interface SettingProperties

                Object whose keys are setting IDs and whose values are settings objects

                -
                interface SettingProperties {
                    [k: ReferencedItem]: Setting;
                }

                Indexable

                \ No newline at end of file +
                interface SettingProperties {
                    [k: ReferencedItem]: Setting;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index 0d35219301..42152fb0f5 100644 --- a/platform-bible-utils/interfaces/SettingsGroup.html +++ b/platform-bible-utils/interfaces/SettingsGroup.html @@ -1,7 +1,7 @@ SettingsGroup | platform-bible-utils

                Interface SettingsGroup

                Group of related settings definitions

                -
                interface SettingsGroup {
                    description?: `%${string}%`;
                    label: `%${string}%`;
                    properties: SettingProperties;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                interface SettingsGroup {
                    description?: `%${string}%`;
                    label: `%${string}%`;
                    properties: SettingProperties;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                description?: `%${string}%`

                LocalizeKey that displays in the settings dialog to describe the group

                -
                label: `%${string}%`

                LocalizeKey that displays in the settings dialog as the group name

                -
                properties: SettingProperties
                \ No newline at end of file +
                label: `%${string}%`

                LocalizeKey that displays in the settings dialog as the group name

                +
                properties: SettingProperties
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index 7639b6a1d0..46a1b09e41 100644 --- a/platform-bible-utils/interfaces/StateBase.html +++ b/platform-bible-utils/interfaces/StateBase.html @@ -1,7 +1,7 @@ StateBase | platform-bible-utils

                Base information needed to describe a state entry

                -
                interface StateBase {
                    default: unknown;
                    derivesFrom?: `${string}.${string}`;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                interface StateBase {
                    default: unknown;
                    derivesFrom?: `${string}.${string}`;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                default: unknown

                Default value for the state/setting

                -
                derivesFrom?: `${string}.${string}`

                A state/setting ID whose value to set to this state/setting's starting value the first time +

                derivesFrom?: `${string}.${string}`

                A state/setting ID whose value to set to this state/setting's starting value the first time this state/setting is loaded

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StringMetadata.html b/platform-bible-utils/interfaces/StringMetadata.html index 13d6544256..4e785efaa5 100644 --- a/platform-bible-utils/interfaces/StringMetadata.html +++ b/platform-bible-utils/interfaces/StringMetadata.html @@ -1,9 +1,9 @@ StringMetadata | platform-bible-utils

                Interface StringMetadata

                Additional non-locale-specific information about a localized string key

                -
                interface StringMetadata {
                    fallbackKey?: `%${string}%`;
                    notes?: string;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                interface StringMetadata {
                    fallbackKey?: `%${string}%`;
                    notes?: string;
                    [k: string]: unknown;
                }

                Indexable

                [k: string]: unknown

                Properties

                Properties

                fallbackKey?: `%${string}%`

                Localized string key from which to get this value if one does not exist in the specified language. If a new key/value pair needs to be made to replace an existing one, this could help smooth over the transition if the meanings are close enough

                -
                notes?: string

                Additional information provided by developers in English to help the translator to know how to +

                notes?: string

                Additional information provided by developers in English to help the translator to know how to translate this localized string accurately

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/StringsMetadata.html b/platform-bible-utils/interfaces/StringsMetadata.html index d4352bacc0..58b0d86f29 100644 --- a/platform-bible-utils/interfaces/StringsMetadata.html +++ b/platform-bible-utils/interfaces/StringsMetadata.html @@ -1,3 +1,3 @@ StringsMetadata | platform-bible-utils

                Interface StringsMetadata

                Map whose keys are localized string keys and whose values provide additional non-locale-specific information about the localized string key

                -
                interface StringsMetadata {
                    [k: LocalizeKey]: StringMetadata;
                }

                Indexable

                \ No newline at end of file +
                interface StringsMetadata {
                    [k: LocalizeKey]: StringMetadata;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index 73ce7f29c3..68b86e9cc4 100644 --- a/platform-bible-utils/interfaces/UserStateContribution.html +++ b/platform-bible-utils/interfaces/UserStateContribution.html @@ -1,2 +1,2 @@ UserStateContribution | platform-bible-utils

                Interface UserStateContribution

                The data an extension provides to inform Platform.Bible of the user state it provides

                -
                interface UserStateContribution {
                    [k: ReferencedItem]: UserState;
                }

                Indexable

                \ No newline at end of file +
                interface UserStateContribution {
                    [k: ReferencedItem]: UserState;
                }

                Indexable

                \ No newline at end of file diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 61460faec4..7e9e44f299 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

                \ No newline at end of file +

                Type Parameters

                \ No newline at end of file diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index 335eaf99ed..27cd07c8e3 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

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index 0d208ff4a6..9d2d69b5fd 100644 --- a/platform-bible-utils/types/DeepPartial.html +++ b/platform-bible-utils/types/DeepPartial.html @@ -1,2 +1,2 @@ DeepPartial | platform-bible-utils

                Type alias DeepPartial<T>

                DeepPartial<T>: T extends object
                    ? {
                        [P in keyof T]?: DeepPartial<T[P]>
                    }
                    : T

                Within type T, recursively change all properties to be optional

                -

                Type Parameters

                • T
                \ No newline at end of file +

                Type Parameters

                • T
                \ No newline at end of file diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index 6c99ba354c..846326deb5 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

                • copyDocuments: boolean
                • ignoreDuplicateProperties: boolean
                \ No newline at end of file +

                Type declaration

                • copyDocuments: boolean
                • ignoreDuplicateProperties: boolean
                \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index 333944e93a..c208f4d0f0 100644 --- a/platform-bible-utils/types/ExtensionControlledProjectSetting.html +++ b/platform-bible-utils/types/ExtensionControlledProjectSetting.html @@ -1,2 +1,2 @@ ExtensionControlledProjectSetting | platform-bible-utils

                Type alias ExtensionControlledProjectSetting

                ExtensionControlledProjectSetting: ProjectSettingBase & ModifierExtensionControlled

                Setting definition that is validated by the extension.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index a59ed5c4e7..5802a1f5ff 100644 --- a/platform-bible-utils/types/ExtensionControlledSetting.html +++ b/platform-bible-utils/types/ExtensionControlledSetting.html @@ -1,2 +1,2 @@ ExtensionControlledSetting | platform-bible-utils

                Type alias ExtensionControlledSetting

                ExtensionControlledSetting: SettingBase & ModifierExtensionControlled

                Setting definition that is validated by the extension.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index 01aeedb709..d5a9022b7f 100644 --- a/platform-bible-utils/types/ExtensionControlledState.html +++ b/platform-bible-utils/types/ExtensionControlledState.html @@ -1,2 +1,2 @@ ExtensionControlledState | platform-bible-utils

                Type alias ExtensionControlledState

                ExtensionControlledState: StateBase & ModifierExtensionControlled

                State definition that is validated by the extension.

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index 14cc14a500..76e211a80c 100644 --- a/platform-bible-utils/types/GroupsInMultiColumnMenu.html +++ b/platform-bible-utils/types/GroupsInMultiColumnMenu.html @@ -1,4 +1,4 @@ GroupsInMultiColumnMenu | platform-bible-utils

                Type alias GroupsInMultiColumnMenu

                GroupsInMultiColumnMenu: {
                    [property: ReferencedItem]: MenuGroupDetailsInColumn | MenuGroupDetailsInSubMenu;
                }

                Group of menu items that can be combined with other groups to form a single menu/submenu within a multi-column menu. Groups are separated using a line within the menu/submenu.

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index 725164e4c3..3616107236 100644 --- a/platform-bible-utils/types/GroupsInSingleColumnMenu.html +++ b/platform-bible-utils/types/GroupsInSingleColumnMenu.html @@ -1,4 +1,4 @@ GroupsInSingleColumnMenu | platform-bible-utils

                Type alias GroupsInSingleColumnMenu

                GroupsInSingleColumnMenu: {
                    [property: ReferencedItem]: OrderedExtensibleContainer | MenuGroupDetailsInSubMenu;
                }

                Group of menu items that can be combined with other groups to form a single context menu/submenu. Groups are separated using a line within the menu/submenu.

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index d49744c058..3925b59a06 100644 --- a/platform-bible-utils/types/JsonDocumentLike.html +++ b/platform-bible-utils/types/JsonDocumentLike.html @@ -1 +1 @@ -JsonDocumentLike | platform-bible-utils

                Type alias JsonDocumentLike

                JsonDocumentLike: JsonObjectLike | JsonArrayLike
                \ No newline at end of file +JsonDocumentLike | platform-bible-utils

                Type alias JsonDocumentLike

                JsonDocumentLike: JsonObjectLike | JsonArrayLike
                \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index 52f2ea9851..dbfd804d7e 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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index 3dd417935d..1e334b3659 100644 --- a/platform-bible-utils/types/Localized.html +++ b/platform-bible-utils/types/Localized.html @@ -1,3 +1,3 @@ Localized | platform-bible-utils

                Type alias Localized<T>

                Localized<T>: ReplaceType<ReplaceType<T, LocalizeKey, string>, ReferencedItem, string>

                Type that converts any menu type before it is localized to what it is after it is localized. This can be applied to any menu type as needed.

                -

                Type Parameters

                • T
                \ No newline at end of file +

                Type Parameters

                • T
                \ No newline at end of file diff --git a/platform-bible-utils/types/LocalizedStringValue.html b/platform-bible-utils/types/LocalizedStringValue.html index 6e028da6f6..4bf3e39d40 100644 --- a/platform-bible-utils/types/LocalizedStringValue.html +++ b/platform-bible-utils/types/LocalizedStringValue.html @@ -1,2 +1,2 @@ LocalizedStringValue | platform-bible-utils

                Type alias LocalizedStringValue

                LocalizedStringValue: string

                Localized string value associated with this key

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index 9a1987e31f..fdcd8cd473 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index 4a246c6789..f42245397b 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

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index 89b95e1bc4..715512aec5 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index 9cc2078b11..9212fe42dd 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

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index 648a0f6543..ad848e2330 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -2,4 +2,4 @@

                Type declaration

                • command: ReferencedItem

                  Name of the PAPI command to run when this menu item is selected.

                • Optional iconPathAfter?: string

                  Path to the icon to display after the menu text

                • Optional iconPathBefore?: string

                  Path to the icon to display before the menu text

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index 54989f7986..bf2d6c2cc2 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

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index eefdd92a3b..06cefeb490 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index 74df79bb5a..ec9c8a6ca0 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

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index c6898b3244..e7a03ab0c0 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)

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index 5862112d6b..6cc4025175 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

                Type Parameters

                • T

                Type declaration

                Returns

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

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index 7dc23c119c..9c16d52e32 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

                \ No newline at end of file +

                Type Parameters

                • T

                Type declaration

                \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index 5cf19b7658..4906e49853 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

                \ No newline at end of file +

                Type Parameters

                • T

                Type declaration

                  • (event): void
                  • Parameters

                    • event: T

                    Returns void

                \ No newline at end of file diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index 6a5035d33f..f008382888 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

                -
              • \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index ff40821ac1..e8a387516a 100644 --- a/platform-bible-utils/types/ProjectSetting.html +++ b/platform-bible-utils/types/ProjectSetting.html @@ -1,2 +1,2 @@ ProjectSetting | platform-bible-utils

                Type alias ProjectSetting

                A description of an extension's setting entry

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index 9e1cc4e07b..ca689ad54a 100644 --- a/platform-bible-utils/types/ProjectSettingBase.html +++ b/platform-bible-utils/types/ProjectSettingBase.html @@ -1,2 +1,2 @@ ProjectSettingBase | platform-bible-utils

                Type alias ProjectSettingBase

                ProjectSettingBase: SettingBase & ModifierProject

                Base information needed to describe a project setting entry

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index aed9a38a3f..3222093557 100644 --- a/platform-bible-utils/types/ProjectSettingsContribution.html +++ b/platform-bible-utils/types/ProjectSettingsContribution.html @@ -1,2 +1,2 @@ ProjectSettingsContribution | platform-bible-utils

                Type alias ProjectSettingsContribution

                ProjectSettingsContribution: ProjectSettingsGroup | ProjectSettingsGroup[]

                The data an extension provides to inform Platform.Bible of the project settings it provides

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index 2cbef59c8e..9e25c7fd0f 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)

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index ccb1af1733..a80b5eab4d 100644 --- a/platform-bible-utils/types/ReplaceType.html +++ b/platform-bible-utils/types/ReplaceType.html @@ -1,2 +1,2 @@ ReplaceType | platform-bible-utils

                Type alias ReplaceType<T, A, B>

                ReplaceType<T, A, B>: T extends A
                    ? B
                    : T extends object
                        ? {
                            [K in keyof T]: ReplaceType<T[K], A, B>
                        }
                        : T

                Within type T, recursively change properties that were of type A to be of type B

                -

                Type Parameters

                • T
                • A
                • B
                \ No newline at end of file +

                Type Parameters

                • T
                • A
                • B
                \ No newline at end of file diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index 6233fd227a..bf431f4fa7 100644 --- a/platform-bible-utils/types/Setting.html +++ b/platform-bible-utils/types/Setting.html @@ -1,2 +1,2 @@ Setting | platform-bible-utils

                Type alias Setting

                A description of an extension's setting entry

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index 263beb46d0..fbc470d456 100644 --- a/platform-bible-utils/types/SettingBase.html +++ b/platform-bible-utils/types/SettingBase.html @@ -1,4 +1,4 @@ SettingBase | platform-bible-utils

                Type alias SettingBase

                SettingBase: StateBase & {
                    description?: LocalizeKey;
                    label: LocalizeKey;
                    [k: string]: unknown;
                }

                Base information needed to describe a setting entry

                Type declaration

                • [k: string]: unknown
                • Optional description?: LocalizeKey

                  LocalizeKey that displays in the settings dialog to describe the setting

                • label: LocalizeKey

                  LocalizeKey that displays in the settings dialog as the setting name

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index 0c49109ab8..76213c355f 100644 --- a/platform-bible-utils/types/SettingsContribution.html +++ b/platform-bible-utils/types/SettingsContribution.html @@ -1,2 +1,2 @@ SettingsContribution | platform-bible-utils

                Type alias SettingsContribution

                SettingsContribution: SettingsGroup | SettingsGroup[]

                The data an extension provides to inform Platform.Bible of the settings it provides

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index 757810fa47..15b984c217 100644 --- a/platform-bible-utils/types/SingleColumnMenu.html +++ b/platform-bible-utils/types/SingleColumnMenu.html @@ -1,4 +1,4 @@ SingleColumnMenu | platform-bible-utils

                Type alias SingleColumnMenu

                SingleColumnMenu: {
                    groups: GroupsInSingleColumnMenu;
                    items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
                }

                Menu that contains a column without a header

                Type declaration

                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/UnionToIntersection.html b/platform-bible-utils/types/UnionToIntersection.html index e1427acd59..e4950aa0ec 100644 --- a/platform-bible-utils/types/UnionToIntersection.html +++ b/platform-bible-utils/types/UnionToIntersection.html @@ -2,4 +2,4 @@

                Note: this utility type is for use on object types. It may fail on other types.

                Type Parameters

                • U

                Example

                type TypeOne = { one: string };
                type TypeTwo = { two: number };
                type TypeThree = { three: string };

                type TypeNums = { one: TypeOne; two: TypeTwo; three: TypeThree };
                const numNames = ['one', 'two'] as const;
                type TypeNumNames = typeof numNames;

                // Same as `TypeOne | TypeTwo`
                // `{ one: string } | { two: number }`
                type TypeOneTwoUnion = TypeNums[TypeNumNames[number]];

                // Same as `TypeOne & TypeTwo`
                // `{ one: string; two: number }`
                type TypeOneTwoIntersection = UnionToIntersection<TypeOneTwoUnion>;
                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index 91051741f9..bb4a9443d6 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

                \ No newline at end of file +

                Type declaration

                  • (): boolean
                  • Returns boolean

                \ No newline at end of file diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index 165f2c4169..427cbce03c 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>

                \ No newline at end of file +

                Type declaration

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

                \ No newline at end of file diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index 864d2cf6b1..1ef40b775a 100644 --- a/platform-bible-utils/types/UserState.html +++ b/platform-bible-utils/types/UserState.html @@ -1,2 +1,2 @@ UserState | platform-bible-utils

                Type alias UserState

                A description of an extension's user state entry

                -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index 079f9aa2ec..e319cacfac 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

                Type declaration

                • contextMenu: SingleColumnMenu | undefined

                  Menu that opens when you right click on the main body/area of a tab

                • includeDefaults: boolean | undefined

                  Indicates whether the platform default menus should be included for this webview

                • topMenu: MultiColumnMenu | undefined

                  Menu that opens when you click on the top left corner of a tab

                  -
                \ No newline at end of file +
                \ No newline at end of file diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index 9d8548dd7c..4d8258d1d2 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

                \ No newline at end of file +
                \ 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 1e142651d9..8aff0c8ac0 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
                \ No newline at end of file +FIRST_SCR_BOOK_NUM | platform-bible-utils

                Variable FIRST_SCR_BOOK_NUMConst

                FIRST_SCR_BOOK_NUM: 1 = 1
                \ 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 01b16cc587..ea195e8704 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
                \ No newline at end of file +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

                Variable FIRST_SCR_CHAPTER_NUMConst

                FIRST_SCR_CHAPTER_NUM: 1 = 1
                \ 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 52768f9df0..fb55a50775 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
                \ No newline at end of file +FIRST_SCR_VERSE_NUM | platform-bible-utils

                Variable FIRST_SCR_VERSE_NUMConst

                FIRST_SCR_VERSE_NUM: 1 = 1
                \ 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 d374def08f..6e2ff1ed71 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 = ...
                \ No newline at end of file +LAST_SCR_BOOK_NUM | platform-bible-utils

                Variable LAST_SCR_BOOK_NUMConst

                LAST_SCR_BOOK_NUM: number = ...
                \ No newline at end of file diff --git a/platform-bible-utils/variables/localizedStringsDocumentSchema.html b/platform-bible-utils/variables/localizedStringsDocumentSchema.html index 6ae3f5965a..cc686ddd90 100644 --- a/platform-bible-utils/variables/localizedStringsDocumentSchema.html +++ b/platform-bible-utils/variables/localizedStringsDocumentSchema.html @@ -1,2 +1,2 @@ localizedStringsDocumentSchema | platform-bible-utils

                Variable localizedStringsDocumentSchemaConst

                localizedStringsDocumentSchema: {
                    $defs: {
                        languageStrings: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^%[\w\-\.]+%$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                        localizeKey: {
                            description: string;
                            pattern: string;
                            tsType: string;
                            type: string;
                        };
                        localizedStringValue: {
                            description: string;
                            type: string;
                        };
                        stringMetadata: {
                            description: string;
                            properties: {
                                fallbackKey: {
                                    $ref: string;
                                    description: string;
                                };
                                notes: {
                                    description: string;
                                    type: string;
                                };
                            };
                            type: string;
                        };
                        stringsMetadata: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^%[\w\-\.]+%$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                    };
                    $schema: string;
                    description: string;
                    properties: {
                        localizedStrings: {
                            additionalProperties: {
                                $ref: string;
                            };
                            type: string;
                        };
                        metadata: {
                            $ref: string;
                        };
                    };
                    title: string;
                    type: string;
                } = ...

                JSON schema object that aligns with the LocalizedStringDataContribution type

                -

                Type declaration

                • $defs: {
                      languageStrings: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^%[\w\-\.]+%$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      localizeKey: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      localizedStringValue: {
                          description: string;
                          type: string;
                      };
                      stringMetadata: {
                          description: string;
                          properties: {
                              fallbackKey: {
                                  $ref: string;
                                  description: string;
                              };
                              notes: {
                                  description: string;
                                  type: string;
                              };
                          };
                          type: string;
                      };
                      stringsMetadata: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^%[\w\-\.]+%$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                  }
                  • languageStrings: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^%[\w\-\.]+%$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^%[\w\-\.]+%$: {
                              $ref: string;
                          };
                      }
                      • ^%[\w\-\.]+%$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizedStringValue: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • stringMetadata: {
                        description: string;
                        properties: {
                            fallbackKey: {
                                $ref: string;
                                description: string;
                            };
                            notes: {
                                description: string;
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          fallbackKey: {
                              $ref: string;
                              description: string;
                          };
                          notes: {
                              description: string;
                              type: string;
                          };
                      }
                      • fallbackKey: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • notes: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                    • type: string
                  • stringsMetadata: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^%[\w\-\.]+%$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^%[\w\-\.]+%$: {
                              $ref: string;
                          };
                      }
                      • ^%[\w\-\.]+%$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • description: string
                • properties: {
                      localizedStrings: {
                          additionalProperties: {
                              $ref: string;
                          };
                          type: string;
                      };
                      metadata: {
                          $ref: string;
                      };
                  }
                  • localizedStrings: {
                        additionalProperties: {
                            $ref: string;
                        };
                        type: string;
                    }
                    • additionalProperties: {
                          $ref: string;
                      }
                      • $ref: string
                    • type: string
                  • metadata: {
                        $ref: string;
                    }
                    • $ref: string
                • title: string
                • type: string
                \ No newline at end of file +

                Type declaration

                • $defs: {
                      languageStrings: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^%[\w\-\.]+%$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      localizeKey: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      localizedStringValue: {
                          description: string;
                          type: string;
                      };
                      stringMetadata: {
                          description: string;
                          properties: {
                              fallbackKey: {
                                  $ref: string;
                                  description: string;
                              };
                              notes: {
                                  description: string;
                                  type: string;
                              };
                          };
                          type: string;
                      };
                      stringsMetadata: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^%[\w\-\.]+%$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                  }
                  • languageStrings: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^%[\w\-\.]+%$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^%[\w\-\.]+%$: {
                              $ref: string;
                          };
                      }
                      • ^%[\w\-\.]+%$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizedStringValue: {
                        description: string;
                        type: string;
                    }
                    • description: string
                    • type: string
                  • stringMetadata: {
                        description: string;
                        properties: {
                            fallbackKey: {
                                $ref: string;
                                description: string;
                            };
                            notes: {
                                description: string;
                                type: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          fallbackKey: {
                              $ref: string;
                              description: string;
                          };
                          notes: {
                              description: string;
                              type: string;
                          };
                      }
                      • fallbackKey: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • notes: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                    • type: string
                  • stringsMetadata: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^%[\w\-\.]+%$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^%[\w\-\.]+%$: {
                              $ref: string;
                          };
                      }
                      • ^%[\w\-\.]+%$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • description: string
                • properties: {
                      localizedStrings: {
                          additionalProperties: {
                              $ref: string;
                          };
                          type: string;
                      };
                      metadata: {
                          $ref: string;
                      };
                  }
                  • localizedStrings: {
                        additionalProperties: {
                            $ref: string;
                        };
                        type: string;
                    }
                    • additionalProperties: {
                          $ref: string;
                      }
                      • $ref: string
                    • type: string
                  • metadata: {
                        $ref: string;
                    }
                    • $ref: string
                • title: string
                • type: string
                \ No newline at end of file diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index af31b0f14c..760c226e9c 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
                \ No newline at end of file +

                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
                \ No newline at end of file diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index 69ae7af5b7..b3131ebcf8 100644 --- a/platform-bible-utils/variables/projectSettingsDocumentSchema.html +++ b/platform-bible-utils/variables/projectSettingsDocumentSchema.html @@ -1,2 +1,2 @@ projectSettingsDocumentSchema | platform-bible-utils

                Variable projectSettingsDocumentSchemaConst

                projectSettingsDocumentSchema: {
                    $defs: {
                        extensionControlledProjectSetting: {
                            allOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        extensionControlledSetting: {
                            allOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        extensionControlledState: {
                            allOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        id: {
                            description: string;
                            pattern: string;
                            tsType: string;
                            type: string;
                        };
                        localizeKey: {
                            description: string;
                            pattern: string;
                            tsType: string;
                            type: string;
                        };
                        modifierExtensionControlled: {
                            description: string;
                            not: {
                                anyOf: {
                                    required: string[];
                                    type: string;
                                }[];
                            };
                        };
                        modifierProject: {
                            description: string;
                            properties: {
                                excludePdpFactoryIds: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            type: string;
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                                excludeProjectInterfaces: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            anyOf: ((...) | (...))[];
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                                includePdpFactoryIds: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            type: string;
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                                includeProjectInterfaces: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            anyOf: ((...) | (...))[];
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                            };
                            type: string;
                        };
                        projectSetting: {
                            anyOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        projectSettingBase: {
                            allOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        projectSettingProperties: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^[\w\-]+\.[\w\-]+$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                        projectSettingsContribution: {
                            anyOf: ({
                                $ref: string;
                                items?: undefined;
                                type?: undefined;
                            } | {
                                $ref?: undefined;
                                items: {
                                    $ref: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        projectSettingsGroup: {
                            description: string;
                            properties: {
                                description: {
                                    $ref: string;
                                    description: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                                properties: {
                                    $ref: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                        projectStateContribution: {
                            $ref: string;
                            description: string;
                        };
                        setting: {
                            anyOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        settingBase: {
                            allOf: ({
                                $ref: string;
                                properties?: undefined;
                                required?: undefined;
                                type?: undefined;
                            } | {
                                $ref?: undefined;
                                properties: {
                                    description: {
                                        $ref: string;
                                        description: string;
                                    };
                                    label: {
                                        $ref: string;
                                        description: string;
                                    };
                                };
                                required: string[];
                                type: string;
                            })[];
                            description: string;
                        };
                        settingProperties: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^[\w-]+\.[\w-]+$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                        settingsContribution: {
                            anyOf: ({
                                $ref: string;
                                items?: undefined;
                                type?: undefined;
                            } | {
                                $ref?: undefined;
                                items: {
                                    $ref: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        settingsGroup: {
                            description: string;
                            properties: {
                                description: {
                                    $ref: string;
                                    description: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                                properties: {
                                    $ref: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                        stateBase: {
                            description: string;
                            properties: {
                                default: {
                                    description: string;
                                    type: string;
                                };
                                derivesFrom: {
                                    $ref: string;
                                    description: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                        userState: {
                            anyOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        userStateContribution: {
                            $ref: string;
                            description: string;
                        };
                        userStateProperties: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^[\w\-]+\.[\w\-]+$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                    };
                    $schema: string;
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                    title: string;
                } = ...

                JSON schema object that aligns with the ProjectSettingsContribution type

                -

                Type declaration

                • $defs: {
                      extensionControlledProjectSetting: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      extensionControlledSetting: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      extensionControlledState: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      id: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      localizeKey: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      modifierExtensionControlled: {
                          description: string;
                          not: {
                              anyOf: {
                                  required: string[];
                                  type: string;
                              }[];
                          };
                      };
                      modifierProject: {
                          description: string;
                          properties: {
                              excludePdpFactoryIds: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              excludeProjectInterfaces: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          anyOf: ((...) | (...))[];
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includePdpFactoryIds: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includeProjectInterfaces: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          anyOf: ((...) | (...))[];
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                          };
                          type: string;
                      };
                      projectSetting: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      projectSettingBase: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      projectSettingProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w\-]+\.[\w\-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      projectSettingsContribution: {
                          anyOf: ({
                              $ref: string;
                              items?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      projectSettingsGroup: {
                          description: string;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              properties: {
                                  $ref: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      projectStateContribution: {
                          $ref: string;
                          description: string;
                      };
                      setting: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      settingBase: {
                          allOf: ({
                              $ref: string;
                              properties?: undefined;
                              required?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              properties: {
                                  description: {
                                      $ref: string;
                                      description: string;
                                  };
                                  label: {
                                      $ref: string;
                                      description: string;
                                  };
                              };
                              required: string[];
                              type: string;
                          })[];
                          description: string;
                      };
                      settingProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w-]+\.[\w-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      settingsContribution: {
                          anyOf: ({
                              $ref: string;
                              items?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      settingsGroup: {
                          description: string;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              properties: {
                                  $ref: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      stateBase: {
                          description: string;
                          properties: {
                              default: {
                                  description: string;
                                  type: string;
                              };
                              derivesFrom: {
                                  $ref: string;
                                  description: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      userState: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      userStateContribution: {
                          $ref: string;
                          description: string;
                      };
                      userStateProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w\-]+\.[\w\-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                  }
                  • extensionControlledProjectSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledState: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • id: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • modifierExtensionControlled: {
                        description: string;
                        not: {
                            anyOf: {
                                required: string[];
                                type: string;
                            }[];
                        };
                    }
                    • description: string
                    • not: {
                          anyOf: {
                              required: string[];
                              type: string;
                          }[];
                      }
                      • anyOf: {
                            required: string[];
                            type: string;
                        }[]
                  • modifierProject: {
                        description: string;
                        properties: {
                            excludePdpFactoryIds: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            excludeProjectInterfaces: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        anyOf: ((...) | (...))[];
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includePdpFactoryIds: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includeProjectInterfaces: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        anyOf: ((...) | (...))[];
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          excludePdpFactoryIds: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          excludeProjectInterfaces: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      anyOf: ((...) | (...))[];
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includePdpFactoryIds: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includeProjectInterfaces: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      anyOf: ((...) | (...))[];
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                      }
                      • excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                      • includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                    • type: string
                  • projectSetting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingBase: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • projectSettingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • anyOf: ({
                          $ref: string;
                          items?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          items: {
                              $ref: string;
                          };
                          type: string;
                      })[]
                    • description: string
                  • projectSettingsGroup: {
                        description: string;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            properties: {
                                $ref: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • projectStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • setting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • settingBase: {
                        allOf: ({
                            $ref: string;
                            properties?: undefined;
                            required?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            properties: {
                                description: {
                                    $ref: string;
                                    description: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                            };
                            required: string[];
                            type: string;
                        })[];
                        description: string;
                    }
                    • allOf: ({
                          $ref: string;
                          properties?: undefined;
                          required?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                          };
                          required: string[];
                          type: string;
                      })[]
                    • description: string
                  • settingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w-]+\.[\w-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w-]+\.[\w-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • settingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • anyOf: ({
                          $ref: string;
                          items?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          items: {
                              $ref: string;
                          };
                          type: string;
                      })[]
                    • description: string
                  • settingsGroup: {
                        description: string;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            properties: {
                                $ref: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • stateBase: {
                        description: string;
                        properties: {
                            default: {
                                description: string;
                                type: string;
                            };
                            derivesFrom: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          default: {
                              description: string;
                              type: string;
                          };
                          derivesFrom: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • default: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • derivesFrom: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                    • required: string[]
                    • type: string
                  • userState: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • userStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • userStateProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[]
                • description: string
                • title: string
                \ No newline at end of file +

                Type declaration

                • $defs: {
                      extensionControlledProjectSetting: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      extensionControlledSetting: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      extensionControlledState: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      id: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      localizeKey: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      modifierExtensionControlled: {
                          description: string;
                          not: {
                              anyOf: {
                                  required: string[];
                                  type: string;
                              }[];
                          };
                      };
                      modifierProject: {
                          description: string;
                          properties: {
                              excludePdpFactoryIds: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              excludeProjectInterfaces: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          anyOf: ((...) | (...))[];
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includePdpFactoryIds: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includeProjectInterfaces: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          anyOf: ((...) | (...))[];
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                          };
                          type: string;
                      };
                      projectSetting: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      projectSettingBase: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      projectSettingProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w\-]+\.[\w\-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      projectSettingsContribution: {
                          anyOf: ({
                              $ref: string;
                              items?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      projectSettingsGroup: {
                          description: string;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              properties: {
                                  $ref: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      projectStateContribution: {
                          $ref: string;
                          description: string;
                      };
                      setting: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      settingBase: {
                          allOf: ({
                              $ref: string;
                              properties?: undefined;
                              required?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              properties: {
                                  description: {
                                      $ref: string;
                                      description: string;
                                  };
                                  label: {
                                      $ref: string;
                                      description: string;
                                  };
                              };
                              required: string[];
                              type: string;
                          })[];
                          description: string;
                      };
                      settingProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w-]+\.[\w-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      settingsContribution: {
                          anyOf: ({
                              $ref: string;
                              items?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      settingsGroup: {
                          description: string;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              properties: {
                                  $ref: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      stateBase: {
                          description: string;
                          properties: {
                              default: {
                                  description: string;
                                  type: string;
                              };
                              derivesFrom: {
                                  $ref: string;
                                  description: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      userState: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      userStateContribution: {
                          $ref: string;
                          description: string;
                      };
                      userStateProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w\-]+\.[\w\-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                  }
                  • extensionControlledProjectSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledState: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • id: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • modifierExtensionControlled: {
                        description: string;
                        not: {
                            anyOf: {
                                required: string[];
                                type: string;
                            }[];
                        };
                    }
                    • description: string
                    • not: {
                          anyOf: {
                              required: string[];
                              type: string;
                          }[];
                      }
                      • anyOf: {
                            required: string[];
                            type: string;
                        }[]
                  • modifierProject: {
                        description: string;
                        properties: {
                            excludePdpFactoryIds: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            excludeProjectInterfaces: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        anyOf: ((...) | (...))[];
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includePdpFactoryIds: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includeProjectInterfaces: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        anyOf: ((...) | (...))[];
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          excludePdpFactoryIds: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          excludeProjectInterfaces: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      anyOf: ((...) | (...))[];
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includePdpFactoryIds: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includeProjectInterfaces: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      anyOf: ((...) | (...))[];
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                      }
                      • excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                      • includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                    • type: string
                  • projectSetting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingBase: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • projectSettingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • anyOf: ({
                          $ref: string;
                          items?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          items: {
                              $ref: string;
                          };
                          type: string;
                      })[]
                    • description: string
                  • projectSettingsGroup: {
                        description: string;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            properties: {
                                $ref: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • projectStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • setting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • settingBase: {
                        allOf: ({
                            $ref: string;
                            properties?: undefined;
                            required?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            properties: {
                                description: {
                                    $ref: string;
                                    description: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                            };
                            required: string[];
                            type: string;
                        })[];
                        description: string;
                    }
                    • allOf: ({
                          $ref: string;
                          properties?: undefined;
                          required?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                          };
                          required: string[];
                          type: string;
                      })[]
                    • description: string
                  • settingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w-]+\.[\w-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w-]+\.[\w-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • settingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • anyOf: ({
                          $ref: string;
                          items?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          items: {
                              $ref: string;
                          };
                          type: string;
                      })[]
                    • description: string
                  • settingsGroup: {
                        description: string;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            properties: {
                                $ref: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • stateBase: {
                        description: string;
                        properties: {
                            default: {
                                description: string;
                                type: string;
                            };
                            derivesFrom: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          default: {
                              description: string;
                              type: string;
                          };
                          derivesFrom: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • default: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • derivesFrom: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                    • required: string[]
                    • type: string
                  • userState: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • userStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • userStateProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[]
                • description: string
                • title: string
                \ No newline at end of file diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index 9176626081..d376098601 100644 --- a/platform-bible-utils/variables/settingsDocumentSchema.html +++ b/platform-bible-utils/variables/settingsDocumentSchema.html @@ -1,2 +1,2 @@ settingsDocumentSchema | platform-bible-utils

                Variable settingsDocumentSchemaConst

                settingsDocumentSchema: {
                    $defs: {
                        extensionControlledProjectSetting: {
                            allOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        extensionControlledSetting: {
                            allOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        extensionControlledState: {
                            allOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        id: {
                            description: string;
                            pattern: string;
                            tsType: string;
                            type: string;
                        };
                        localizeKey: {
                            description: string;
                            pattern: string;
                            tsType: string;
                            type: string;
                        };
                        modifierExtensionControlled: {
                            description: string;
                            not: {
                                anyOf: {
                                    required: string[];
                                    type: string;
                                }[];
                            };
                        };
                        modifierProject: {
                            description: string;
                            properties: {
                                excludePdpFactoryIds: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            type: string;
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                                excludeProjectInterfaces: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            anyOf: ((...) | (...))[];
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                                includePdpFactoryIds: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            type: string;
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                                includeProjectInterfaces: {
                                    anyOf: ({
                                        items?: undefined;
                                        type: string;
                                    } | {
                                        items: {
                                            anyOf: ((...) | (...))[];
                                        };
                                        type: string;
                                    })[];
                                    description: string;
                                };
                            };
                            type: string;
                        };
                        projectSetting: {
                            anyOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        projectSettingBase: {
                            allOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        projectSettingProperties: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^[\w\-]+\.[\w\-]+$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                        projectSettingsContribution: {
                            anyOf: ({
                                $ref: string;
                                items?: undefined;
                                type?: undefined;
                            } | {
                                $ref?: undefined;
                                items: {
                                    $ref: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        projectSettingsGroup: {
                            description: string;
                            properties: {
                                description: {
                                    $ref: string;
                                    description: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                                properties: {
                                    $ref: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                        projectStateContribution: {
                            $ref: string;
                            description: string;
                        };
                        setting: {
                            anyOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        settingBase: {
                            allOf: ({
                                $ref: string;
                                properties?: undefined;
                                required?: undefined;
                                type?: undefined;
                            } | {
                                $ref?: undefined;
                                properties: {
                                    description: {
                                        $ref: string;
                                        description: string;
                                    };
                                    label: {
                                        $ref: string;
                                        description: string;
                                    };
                                };
                                required: string[];
                                type: string;
                            })[];
                            description: string;
                        };
                        settingProperties: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^[\w-]+\.[\w-]+$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                        settingsContribution: {
                            anyOf: ({
                                $ref: string;
                                items?: undefined;
                                type?: undefined;
                            } | {
                                $ref?: undefined;
                                items: {
                                    $ref: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        };
                        settingsGroup: {
                            description: string;
                            properties: {
                                description: {
                                    $ref: string;
                                    description: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                                properties: {
                                    $ref: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                        stateBase: {
                            description: string;
                            properties: {
                                default: {
                                    description: string;
                                    type: string;
                                };
                                derivesFrom: {
                                    $ref: string;
                                    description: string;
                                };
                            };
                            required: string[];
                            type: string;
                        };
                        userState: {
                            anyOf: {
                                $ref: string;
                            }[];
                            description: string;
                        };
                        userStateContribution: {
                            $ref: string;
                            description: string;
                        };
                        userStateProperties: {
                            additionalProperties: boolean;
                            description: string;
                            patternProperties: {
                                ^[\w\-]+\.[\w\-]+$: {
                                    $ref: string;
                                };
                            };
                            type: string;
                        };
                    };
                    $schema: string;
                    anyOf: ({
                        $ref: string;
                        items?: undefined;
                        type?: undefined;
                    } | {
                        $ref?: undefined;
                        items: {
                            $ref: string;
                        };
                        type: string;
                    })[];
                    description: string;
                    title: string;
                } = ...

                JSON schema object that aligns with the SettingsContribution type

                -

                Type declaration

                • $defs: {
                      extensionControlledProjectSetting: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      extensionControlledSetting: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      extensionControlledState: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      id: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      localizeKey: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      modifierExtensionControlled: {
                          description: string;
                          not: {
                              anyOf: {
                                  required: string[];
                                  type: string;
                              }[];
                          };
                      };
                      modifierProject: {
                          description: string;
                          properties: {
                              excludePdpFactoryIds: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              excludeProjectInterfaces: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          anyOf: ((...) | (...))[];
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includePdpFactoryIds: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includeProjectInterfaces: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          anyOf: ((...) | (...))[];
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                          };
                          type: string;
                      };
                      projectSetting: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      projectSettingBase: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      projectSettingProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w\-]+\.[\w\-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      projectSettingsContribution: {
                          anyOf: ({
                              $ref: string;
                              items?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      projectSettingsGroup: {
                          description: string;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              properties: {
                                  $ref: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      projectStateContribution: {
                          $ref: string;
                          description: string;
                      };
                      setting: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      settingBase: {
                          allOf: ({
                              $ref: string;
                              properties?: undefined;
                              required?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              properties: {
                                  description: {
                                      $ref: string;
                                      description: string;
                                  };
                                  label: {
                                      $ref: string;
                                      description: string;
                                  };
                              };
                              required: string[];
                              type: string;
                          })[];
                          description: string;
                      };
                      settingProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w-]+\.[\w-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      settingsContribution: {
                          anyOf: ({
                              $ref: string;
                              items?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      settingsGroup: {
                          description: string;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              properties: {
                                  $ref: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      stateBase: {
                          description: string;
                          properties: {
                              default: {
                                  description: string;
                                  type: string;
                              };
                              derivesFrom: {
                                  $ref: string;
                                  description: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      userState: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      userStateContribution: {
                          $ref: string;
                          description: string;
                      };
                      userStateProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w\-]+\.[\w\-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                  }
                  • extensionControlledProjectSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledState: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • id: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • modifierExtensionControlled: {
                        description: string;
                        not: {
                            anyOf: {
                                required: string[];
                                type: string;
                            }[];
                        };
                    }
                    • description: string
                    • not: {
                          anyOf: {
                              required: string[];
                              type: string;
                          }[];
                      }
                      • anyOf: {
                            required: string[];
                            type: string;
                        }[]
                  • modifierProject: {
                        description: string;
                        properties: {
                            excludePdpFactoryIds: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            excludeProjectInterfaces: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        anyOf: ((...) | (...))[];
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includePdpFactoryIds: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includeProjectInterfaces: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        anyOf: ((...) | (...))[];
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          excludePdpFactoryIds: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          excludeProjectInterfaces: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      anyOf: ((...) | (...))[];
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includePdpFactoryIds: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includeProjectInterfaces: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      anyOf: ((...) | (...))[];
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                      }
                      • excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                      • includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                    • type: string
                  • projectSetting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingBase: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • projectSettingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • anyOf: ({
                          $ref: string;
                          items?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          items: {
                              $ref: string;
                          };
                          type: string;
                      })[]
                    • description: string
                  • projectSettingsGroup: {
                        description: string;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            properties: {
                                $ref: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • projectStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • setting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • settingBase: {
                        allOf: ({
                            $ref: string;
                            properties?: undefined;
                            required?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            properties: {
                                description: {
                                    $ref: string;
                                    description: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                            };
                            required: string[];
                            type: string;
                        })[];
                        description: string;
                    }
                    • allOf: ({
                          $ref: string;
                          properties?: undefined;
                          required?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                          };
                          required: string[];
                          type: string;
                      })[]
                    • description: string
                  • settingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w-]+\.[\w-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w-]+\.[\w-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • settingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • anyOf: ({
                          $ref: string;
                          items?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          items: {
                              $ref: string;
                          };
                          type: string;
                      })[]
                    • description: string
                  • settingsGroup: {
                        description: string;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            properties: {
                                $ref: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • stateBase: {
                        description: string;
                        properties: {
                            default: {
                                description: string;
                                type: string;
                            };
                            derivesFrom: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          default: {
                              description: string;
                              type: string;
                          };
                          derivesFrom: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • default: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • derivesFrom: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                    • required: string[]
                    • type: string
                  • userState: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • userStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • userStateProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[]
                • description: string
                • title: string
                \ No newline at end of file +

                Type declaration

                • $defs: {
                      extensionControlledProjectSetting: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      extensionControlledSetting: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      extensionControlledState: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      id: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      localizeKey: {
                          description: string;
                          pattern: string;
                          tsType: string;
                          type: string;
                      };
                      modifierExtensionControlled: {
                          description: string;
                          not: {
                              anyOf: {
                                  required: string[];
                                  type: string;
                              }[];
                          };
                      };
                      modifierProject: {
                          description: string;
                          properties: {
                              excludePdpFactoryIds: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              excludeProjectInterfaces: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          anyOf: ((...) | (...))[];
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includePdpFactoryIds: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          type: string;
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                              includeProjectInterfaces: {
                                  anyOf: ({
                                      items?: undefined;
                                      type: string;
                                  } | {
                                      items: {
                                          anyOf: ((...) | (...))[];
                                      };
                                      type: string;
                                  })[];
                                  description: string;
                              };
                          };
                          type: string;
                      };
                      projectSetting: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      projectSettingBase: {
                          allOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      projectSettingProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w\-]+\.[\w\-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      projectSettingsContribution: {
                          anyOf: ({
                              $ref: string;
                              items?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      projectSettingsGroup: {
                          description: string;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              properties: {
                                  $ref: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      projectStateContribution: {
                          $ref: string;
                          description: string;
                      };
                      setting: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      settingBase: {
                          allOf: ({
                              $ref: string;
                              properties?: undefined;
                              required?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              properties: {
                                  description: {
                                      $ref: string;
                                      description: string;
                                  };
                                  label: {
                                      $ref: string;
                                      description: string;
                                  };
                              };
                              required: string[];
                              type: string;
                          })[];
                          description: string;
                      };
                      settingProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w-]+\.[\w-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                      settingsContribution: {
                          anyOf: ({
                              $ref: string;
                              items?: undefined;
                              type?: undefined;
                          } | {
                              $ref?: undefined;
                              items: {
                                  $ref: string;
                              };
                              type: string;
                          })[];
                          description: string;
                      };
                      settingsGroup: {
                          description: string;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                              properties: {
                                  $ref: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      stateBase: {
                          description: string;
                          properties: {
                              default: {
                                  description: string;
                                  type: string;
                              };
                              derivesFrom: {
                                  $ref: string;
                                  description: string;
                              };
                          };
                          required: string[];
                          type: string;
                      };
                      userState: {
                          anyOf: {
                              $ref: string;
                          }[];
                          description: string;
                      };
                      userStateContribution: {
                          $ref: string;
                          description: string;
                      };
                      userStateProperties: {
                          additionalProperties: boolean;
                          description: string;
                          patternProperties: {
                              ^[\w\-]+\.[\w\-]+$: {
                                  $ref: string;
                              };
                          };
                          type: string;
                      };
                  }
                  • extensionControlledProjectSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledSetting: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • extensionControlledState: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • id: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • localizeKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    }
                    • description: string
                    • pattern: string
                    • tsType: string
                    • type: string
                  • modifierExtensionControlled: {
                        description: string;
                        not: {
                            anyOf: {
                                required: string[];
                                type: string;
                            }[];
                        };
                    }
                    • description: string
                    • not: {
                          anyOf: {
                              required: string[];
                              type: string;
                          }[];
                      }
                      • anyOf: {
                            required: string[];
                            type: string;
                        }[]
                  • modifierProject: {
                        description: string;
                        properties: {
                            excludePdpFactoryIds: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            excludeProjectInterfaces: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        anyOf: ((...) | (...))[];
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includePdpFactoryIds: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        type: string;
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                            includeProjectInterfaces: {
                                anyOf: ({
                                    items?: undefined;
                                    type: string;
                                } | {
                                    items: {
                                        anyOf: ((...) | (...))[];
                                    };
                                    type: string;
                                })[];
                                description: string;
                            };
                        };
                        type: string;
                    }
                    • description: string
                    • properties: {
                          excludePdpFactoryIds: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          excludeProjectInterfaces: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      anyOf: ((...) | (...))[];
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includePdpFactoryIds: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      type: string;
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                          includeProjectInterfaces: {
                              anyOf: ({
                                  items?: undefined;
                                  type: string;
                              } | {
                                  items: {
                                      anyOf: ((...) | (...))[];
                                  };
                                  type: string;
                              })[];
                              description: string;
                          };
                      }
                      • excludePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • excludeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                      • includePdpFactoryIds: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    type: string;
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  type: string;
                              };
                              type: string;
                          })[]
                        • description: string
                      • includeProjectInterfaces: {
                            anyOf: ({
                                items?: undefined;
                                type: string;
                            } | {
                                items: {
                                    anyOf: ((...) | (...))[];
                                };
                                type: string;
                            })[];
                            description: string;
                        }
                        • anyOf: ({
                              items?: undefined;
                              type: string;
                          } | {
                              items: {
                                  anyOf: ((...) | (...))[];
                              };
                              type: string;
                          })[]
                        • description: string
                    • type: string
                  • projectSetting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingBase: {
                        allOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • allOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • projectSettingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • projectSettingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • anyOf: ({
                          $ref: string;
                          items?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          items: {
                              $ref: string;
                          };
                          type: string;
                      })[]
                    • description: string
                  • projectSettingsGroup: {
                        description: string;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            properties: {
                                $ref: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • projectStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • setting: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • settingBase: {
                        allOf: ({
                            $ref: string;
                            properties?: undefined;
                            required?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            properties: {
                                description: {
                                    $ref: string;
                                    description: string;
                                };
                                label: {
                                    $ref: string;
                                    description: string;
                                };
                            };
                            required: string[];
                            type: string;
                        })[];
                        description: string;
                    }
                    • allOf: ({
                          $ref: string;
                          properties?: undefined;
                          required?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          properties: {
                              description: {
                                  $ref: string;
                                  description: string;
                              };
                              label: {
                                  $ref: string;
                                  description: string;
                              };
                          };
                          required: string[];
                          type: string;
                      })[]
                    • description: string
                  • settingProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w-]+\.[\w-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w-]+\.[\w-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w-]+\.[\w-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                  • settingsContribution: {
                        anyOf: ({
                            $ref: string;
                            items?: undefined;
                            type?: undefined;
                        } | {
                            $ref?: undefined;
                            items: {
                                $ref: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    }
                    • anyOf: ({
                          $ref: string;
                          items?: undefined;
                          type?: undefined;
                      } | {
                          $ref?: undefined;
                          items: {
                              $ref: string;
                          };
                          type: string;
                      })[]
                    • description: string
                  • settingsGroup: {
                        description: string;
                        properties: {
                            description: {
                                $ref: string;
                                description: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            properties: {
                                $ref: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          description: {
                              $ref: string;
                              description: string;
                          };
                          label: {
                              $ref: string;
                              description: string;
                          };
                          properties: {
                              $ref: string;
                          };
                      }
                      • description: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • label: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                      • properties: {
                            $ref: string;
                        }
                        • $ref: string
                    • required: string[]
                    • type: string
                  • stateBase: {
                        description: string;
                        properties: {
                            default: {
                                description: string;
                                type: string;
                            };
                            derivesFrom: {
                                $ref: string;
                                description: string;
                            };
                        };
                        required: string[];
                        type: string;
                    }
                    • description: string
                    • properties: {
                          default: {
                              description: string;
                              type: string;
                          };
                          derivesFrom: {
                              $ref: string;
                              description: string;
                          };
                      }
                      • default: {
                            description: string;
                            type: string;
                        }
                        • description: string
                        • type: string
                      • derivesFrom: {
                            $ref: string;
                            description: string;
                        }
                        • $ref: string
                        • description: string
                    • required: string[]
                    • type: string
                  • userState: {
                        anyOf: {
                            $ref: string;
                        }[];
                        description: string;
                    }
                    • anyOf: {
                          $ref: string;
                      }[]
                    • description: string
                  • userStateContribution: {
                        $ref: string;
                        description: string;
                    }
                    • $ref: string
                    • description: string
                  • userStateProperties: {
                        additionalProperties: boolean;
                        description: string;
                        patternProperties: {
                            ^[\w\-]+\.[\w\-]+$: {
                                $ref: string;
                            };
                        };
                        type: string;
                    }
                    • additionalProperties: boolean
                    • description: string
                    • patternProperties: {
                          ^[\w\-]+\.[\w\-]+$: {
                              $ref: string;
                          };
                      }
                      • ^[\w\-]+\.[\w\-]+$: {
                            $ref: string;
                        }
                        • $ref: string
                    • type: string
                • $schema: string
                • anyOf: ({
                      $ref: string;
                      items?: undefined;
                      type?: undefined;
                  } | {
                      $ref?: undefined;
                      items: {
                          $ref: string;
                      };
                      type: string;
                  })[]
                • description: string
                • title: string
                \ No newline at end of file