From 9016c52600cab40e99ea529302ca259fd9efcd31 Mon Sep 17 00:00:00 2001 From: Alan Plum Date: Tue, 16 Apr 2024 20:25:05 +0200 Subject: [PATCH] Update 9.0.0-preview.1 manually --- 9.0.0-preview.1/.nojekyll | 1 + 9.0.0-preview.1/assets/highlight.css | 141 ++ 9.0.0-preview.1/assets/icons.js | 15 + 9.0.0-preview.1/assets/icons.svg | 1 + 9.0.0-preview.1/assets/main.js | 59 + 9.0.0-preview.1/assets/navigation.js | 1 + 9.0.0-preview.1/assets/search.js | 1 + 9.0.0-preview.1/assets/style.css | 1412 +++++++++++++++++ .../classes/analyzer.Analyzer.html | 25 + .../classes/cursor.ArrayCursor.html | 130 ++ .../classes/cursor.BatchedArrayCursor.html | 141 ++ .../classes/database.Database.html | 1237 +++++++++++++++ .../classes/error.ArangoError.html | 17 + 9.0.0-preview.1/classes/error.HttpError.html | 14 + 9.0.0-preview.1/classes/graph.Graph.html | 107 ++ .../classes/graph.GraphEdgeCollection.html | 73 + .../classes/graph.GraphVertexCollection.html | 75 + 9.0.0-preview.1/classes/job.Job.html | 21 + 9.0.0-preview.1/classes/route.Route.html | 108 ++ .../classes/transaction.Transaction.html | 59 + 9.0.0-preview.1/classes/view.View.html | 44 + .../enums/collection.CollectionStatus.html | 8 + .../enums/collection.CollectionType.html | 4 + 9.0.0-preview.1/enums/database.LogLevel.html | 7 + .../functions/analyzer.isArangoAnalyzer.html | 3 + 9.0.0-preview.1/functions/aql.aql.html | 23 + .../functions/aql.isAqlLiteral.html | 3 + 9.0.0-preview.1/functions/aql.isAqlQuery.html | 3 + 9.0.0-preview.1/functions/aql.join.html | 15 + 9.0.0-preview.1/functions/aql.literal.html | 15 + .../collection.collectionToString.html | 4 + .../collection.isArangoCollection.html | 3 + .../functions/database.isArangoDatabase.html | 3 + .../functions/error.isArangoError.html | 3 + .../functions/error.isSystemError.html | 2 + .../functions/graph.isArangoGraph.html | 3 + 9.0.0-preview.1/functions/index.arangojs.html | 12 + .../transaction.isArangoTransaction.html | 3 + .../functions/view.isArangoView.html | 3 + 9.0.0-preview.1/hierarchy.html | 1 + 9.0.0-preview.1/index.html | 153 ++ .../interfaces/aql.AqlLiteral.html | 5 + 9.0.0-preview.1/interfaces/aql.AqlQuery.html | 10 + .../collection.ArangoCollection.html | 6 + .../collection.DocumentCollection.html | 373 +++++ .../interfaces/collection.EdgeCollection.html | 416 +++++ .../interfaces/cursor.CursorExtras.html | 10 + .../interfaces/cursor.CursorStats.html | 36 + .../interfaces/error.SystemError.html | 5 + ...ew.ArangoSearchViewStoredValueOptions.html | 12 + 9.0.0-preview.1/modules/analyzer.html | 49 + 9.0.0-preview.1/modules/aql.html | 14 + 9.0.0-preview.1/modules/collection.html | 54 + 9.0.0-preview.1/modules/connection.html | 12 + 9.0.0-preview.1/modules/cursor.html | 8 + 9.0.0-preview.1/modules/database.html | 70 + 9.0.0-preview.1/modules/documents.html | 14 + 9.0.0-preview.1/modules/error.html | 10 + 9.0.0-preview.1/modules/foxx_manifest.html | 10 + 9.0.0-preview.1/modules/graph.html | 20 + 9.0.0-preview.1/modules/index.html | 12 + 9.0.0-preview.1/modules/indexes.html | 25 + 9.0.0-preview.1/modules/job.html | 2 + 9.0.0-preview.1/modules/route.html | 5 + 9.0.0-preview.1/modules/transaction.html | 10 + 9.0.0-preview.1/modules/view.html | 31 + .../types/analyzer.AnalyzerDescription.html | 2 + .../types/analyzer.AnalyzerFeature.html | 2 + .../analyzer.AqlAnalyzerDescription.html | 2 + ...zer.ClassificationAnalyzerDescription.html | 2 + ...analyzer.CollationAnalyzerDescription.html | 2 + .../types/analyzer.CreateAnalyzerOptions.html | 2 + .../analyzer.CreateAqlAnalyzerOptions.html | 17 + ...r.CreateClassificationAnalyzerOptions.html | 10 + ...alyzer.CreateCollationAnalyzerOptions.html | 7 + ...alyzer.CreateDelimiterAnalyzerOptions.html | 7 + ...analyzer.CreateGeoJsonAnalyzerOptions.html | 12 + ...nalyzer.CreateGeoPointAnalyzerOptions.html | 11 + .../analyzer.CreateGeoS2AnalyzerOptions.html | 19 + ...nalyzer.CreateIdentityAnalyzerOptions.html | 6 + ...analyzer.CreateMinHashAnalyzerOptions.html | 7 + ...r.CreateMultiDelimiterAnalyzerOptions.html | 7 + ...CreateNearestNeighborsAnalyzerOptions.html | 8 + .../analyzer.CreateNgramAnalyzerOptions.html | 8 + .../analyzer.CreateNormAnalyzerOptions.html | 11 + ...nalyzer.CreatePipelineAnalyzerOptions.html | 6 + ...zer.CreateSegmentationAnalyzerOptions.html | 9 + .../analyzer.CreateStemAnalyzerOptions.html | 7 + ...alyzer.CreateStopwordsAnalyzerOptions.html | 8 + .../analyzer.CreateTextAnalyzerOptions.html | 20 + ...nalyzer.CreateWildcardAnalyzerOptions.html | 7 + ...analyzer.DelimiterAnalyzerDescription.html | 2 + .../analyzer.GenericAnalyzerDescription.html | 4 + .../analyzer.GeoJsonAnalyzerDescription.html | 2 + .../analyzer.GeoPointAnalyzerDescription.html | 2 + .../analyzer.GeoS2AnalyzerDescription.html | 2 + .../analyzer.IdentityAnalyzerDescription.html | 2 + .../analyzer.MinHashAnalyzerDescription.html | 2 + ...zer.MultiDelimiterAnalyzerDescription.html | 2 + ...r.NearestNeighborsAnalyzerDescription.html | 2 + .../analyzer.NgramAnalyzerDescription.html | 2 + .../analyzer.NormAnalyzerDescription.html | 2 + .../analyzer.PipelineAnalyzerDescription.html | 2 + ...lyzer.SegmentationAnalyzerDescription.html | 2 + .../analyzer.StemAnalyzerDescription.html | 2 + ...analyzer.StopwordsAnalyzerDescription.html | 2 + .../analyzer.TextAnalyzerDescription.html | 2 + .../analyzer.WildcardAnalyzerDescription.html | 2 + 9.0.0-preview.1/types/aql.AqlValue.html | 3 + ...collection.CollectionBatchReadOptions.html | 5 + .../collection.CollectionChecksumOptions.html | 8 + .../collection.CollectionDropOptions.html | 6 + .../collection.CollectionEdgesOptions.html | 5 + .../collection.CollectionEdgesResult.html | 2 + .../collection.CollectionImportOptions.html | 19 + .../collection.CollectionImportResult.html | 9 + .../collection.CollectionInsertOptions.html | 30 + .../collection.CollectionKeyOptions.html | 8 + .../collection.CollectionKeyProperties.html | 7 + .../types/collection.CollectionMetadata.html | 6 + .../collection.CollectionProperties.html | 25 + ...ollection.CollectionPropertiesOptions.html | 13 + .../collection.CollectionReadOptions.html | 12 + .../collection.CollectionRemoveOptions.html | 16 + .../collection.CollectionReplaceOptions.html | 26 + .../collection.CollectionUpdateOptions.html | 33 + .../collection.ComputedValueOptions.html | 17 + .../collection.ComputedValueProperties.html | 12 + .../collection.CreateCollectionOptions.html | 33 + .../collection.DocumentExistsOptions.html | 6 + .../collection.DocumentOperationFailure.html | 5 + .../collection.DocumentOperationMetadata.html | 3 + .../types/collection.KeyGenerator.html | 2 + .../types/collection.SchemaOptions.html | 6 + .../types/collection.SchemaProperties.html | 6 + .../types/collection.ShardingStrategy.html | 2 + .../collection.SimpleQueryAllOptions.html | 15 + ...ollection.SimpleQueryByExampleOptions.html | 13 + ...collection.SimpleQueryFulltextOptions.html | 7 + .../types/collection.SimpleQueryListType.html | 5 + ...ion.SimpleQueryRemoveByExampleOptions.html | 8 + ...tion.SimpleQueryRemoveByExampleResult.html | 6 + ...ection.SimpleQueryRemoveByKeysOptions.html | 13 + ...lection.SimpleQueryRemoveByKeysResult.html | 8 + ...on.SimpleQueryReplaceByExampleOptions.html | 4 + ...ion.SimpleQueryReplaceByExampleResult.html | 6 + ...ion.SimpleQueryUpdateByExampleOptions.html | 15 + ...tion.SimpleQueryUpdateByExampleResult.html | 6 + .../types/collection.TraversalOptions.html | 80 + .../types/collection.ValidationLevel.html | 9 + .../types/collection.WriteOperation.html | 2 + .../types/connection.ArangoApiResponse.html | 2 + .../connection.ArangoResponseMetadata.html | 4 + .../connection.BasicAuthCredentials.html | 4 + .../connection.BearerAuthCredentials.html | 3 + 9.0.0-preview.1/types/connection.Config.html | 119 ++ .../connection.LoadBalancingStrategy.html | 13 + .../types/connection.RequestOptions.html | 23 + .../types/database.AccessLevel.html | 2 + .../types/database.AqlUserFunction.html | 6 + .../types/database.ArangoUser.html | 5 + 9.0.0-preview.1/types/database.AstNode.html | 2 + .../types/database.ClusterImbalanceInfo.html | 18 + .../types/database.ClusterRebalanceMove.html | 6 + .../database.ClusterRebalanceOptions.html | 15 + .../database.ClusterRebalanceResult.html | 4 + .../types/database.ClusterRebalanceState.html | 4 + .../types/database.CreateDatabaseOptions.html | 12 + .../types/database.CreateDatabaseUser.html | 8 + .../types/database.CreateUserOptions.html | 8 + .../types/database.DatabaseInfo.html | 13 + .../types/database.ExplainOptions.html | 13 + .../types/database.ExplainPlan.html | 9 + .../types/database.ExplainStats.html | 7 + .../types/database.HotBackupList.html | 2 + .../types/database.HotBackupOptions.html | 15 + .../types/database.HotBackupResult.html | 2 + .../types/database.InstallServiceOptions.html | 15 + .../types/database.LogEntries.html | 2 + .../types/database.LogEntriesOptions.html | 13 + .../types/database.LogLevelLabel.html | 2 + .../types/database.LogLevelSetting.html | 2 + .../types/database.LogMessage.html | 2 + .../types/database.LogSortDirection.html | 2 + .../types/database.MultiExplainResult.html | 6 + .../database.MultiServiceDependency.html | 10 + .../types/database.ParseResult.html | 6 + 9.0.0-preview.1/types/database.QueryInfo.html | 12 + .../types/database.QueryOptimizerRule.html | 2 + .../types/database.QueryOptions.html | 80 + .../types/database.QueryTracking.html | 9 + .../types/database.QueryTrackingOptions.html | 11 + .../types/database.QueueTimeMetrics.html | 9 + .../types/database.ReplaceServiceOptions.html | 21 + .../types/database.ServiceConfiguration.html | 15 + .../types/database.ServiceInfo.html | 13 + .../types/database.ServiceSummary.html | 9 + .../database.ServiceTestDefaultReport.html | 2 + .../database.ServiceTestDefaultTest.html | 2 + .../types/database.ServiceTestStats.html | 7 + .../database.ServiceTestStreamReport.html | 2 + .../types/database.ServiceTestStreamTest.html | 2 + .../types/database.ServiceTestSuite.html | 2 + .../database.ServiceTestSuiteReport.html | 2 + .../types/database.ServiceTestSuiteTest.html | 2 + .../types/database.ServiceTestTapReport.html | 2 + .../database.ServiceTestXunitReport.html | 3 + .../types/database.ServiceTestXunitTest.html | 3 + .../types/database.SingleExplainResult.html | 6 + .../database.SingleServiceDependency.html | 10 + .../types/database.SwaggerJson.html | 2 + .../database.TransactionCollections.html | 9 + .../types/database.TransactionDetails.html | 5 + .../types/database.TransactionOptions.html | 14 + .../database.UninstallServiceOptions.html | 9 + .../types/database.UpgradeServiceOptions.html | 21 + .../database.UserAccessLevelOptions.html | 7 + .../types/database.UserOptions.html | 7 + .../types/database.VersionInfo.html | 6 + 9.0.0-preview.1/types/documents.Document.html | 2 + .../types/documents.DocumentData.html | 2 + .../types/documents.DocumentMetadata.html | 7 + .../types/documents.DocumentSelector.html | 5 + 9.0.0-preview.1/types/documents.Edge.html | 2 + 9.0.0-preview.1/types/documents.EdgeData.html | 2 + .../types/documents.EdgeMetadata.html | 4 + .../types/documents.ObjectWithId.html | 3 + .../types/documents.ObjectWithKey.html | 3 + 9.0.0-preview.1/types/documents.Patch.html | 5 + .../types/foxx_manifest.Configuration.html | 6 + .../types/foxx_manifest.Dependency.html | 7 + 9.0.0-preview.1/types/foxx_manifest.File.html | 5 + .../types/foxx_manifest.FoxxManifest.html | 20 + .../types/graph.AddEdgeDefinitionOptions.html | 3 + .../graph.AddVertexCollectionOptions.html | 3 + .../types/graph.CreateGraphOptions.html | 25 + .../types/graph.EdgeDefinition.html | 5 + .../types/graph.EdgeDefinitionOptions.html | 5 + .../graph.GraphCollectionInsertOptions.html | 7 + .../graph.GraphCollectionReadOptions.html | 12 + .../graph.GraphCollectionRemoveOptions.html | 10 + .../graph.GraphCollectionReplaceOptions.html | 16 + 9.0.0-preview.1/types/graph.GraphInfo.html | 19 + .../graph.ReplaceEdgeDefinitionOptions.html | 3 + .../types/indexes.EnsureGeoIndexOptions.html | 31 + .../indexes.EnsureInvertedIndexOptions.html | 65 + .../types/indexes.EnsureMdiIndexOptions.html | 11 + .../indexes.EnsurePersistentIndexOptions.html | 25 + .../types/indexes.EnsureTtlIndexOptions.html | 10 + .../types/indexes.GenericIndex.html | 7 + 9.0.0-preview.1/types/indexes.GeoIndex.html | 2 + 9.0.0-preview.1/types/indexes.Index.html | 2 + .../types/indexes.IndexSelector.html | 2 + .../types/indexes.InvertedIndex.html | 2 + .../indexes.InvertedIndexFieldOptions.html | 27 + .../indexes.InvertedIndexNestedField.html | 3 + ...dexes.InvertedIndexNestedFieldOptions.html | 13 + ....InvertedIndexPrimarySortFieldOptions.html | 4 + ...dexes.InvertedIndexStoredValueOptions.html | 8 + 9.0.0-preview.1/types/indexes.MdiIndex.html | 2 + .../types/indexes.ObjectWithId.html | 1 + .../types/indexes.ObjectWithName.html | 1 + .../types/indexes.PersistentIndex.html | 2 + .../types/indexes.PrimaryIndex.html | 2 + 9.0.0-preview.1/types/indexes.TtlIndex.html | 2 + .../transaction.TransactionAbortOptions.html | 5 + .../transaction.TransactionCommitOptions.html | 5 + .../types/transaction.TransactionStatus.html | 5 + .../view.ArangoSearchViewDescription.html | 1 + .../types/view.ArangoSearchViewLink.html | 2 + .../view.ArangoSearchViewLinkOptions.html | 23 + ...rangoSearchViewPatchPropertiesOptions.html | 2 + .../view.ArangoSearchViewProperties.html | 2 + ...iew.ArangoSearchViewPropertiesOptions.html | 14 + .../view.BytesAccumConsolidationPolicy.html | 7 + 9.0.0-preview.1/types/view.Compression.html | 2 + .../view.CreateArangoSearchViewOptions.html | 26 + .../view.CreateSearchAliasViewOptions.html | 3 + .../types/view.CreateViewOptions.html | 2 + 9.0.0-preview.1/types/view.Direction.html | 2 + .../types/view.GenericViewDescription.html | 5 + .../view.SearchAliasViewDescription.html | 1 + .../view.SearchAliasViewIndexOptions.html | 4 + ...view.SearchAliasViewPatchIndexOptions.html | 4 + ...SearchAliasViewPatchPropertiesOptions.html | 3 + .../types/view.SearchAliasViewProperties.html | 2 + ...view.SearchAliasViewPropertiesOptions.html | 3 + .../types/view.TierConsolidationPolicy.html | 17 + .../types/view.ViewDescription.html | 1 + .../view.ViewPatchPropertiesOptions.html | 2 + .../types/view.ViewProperties.html | 1 + .../types/view.ViewPropertiesOptions.html | 2 + CHANGELOG.md | 71 + MIGRATING.md | 87 + VERSION.md | 2 +- latest | 2 +- 296 files changed, 7323 insertions(+), 2 deletions(-) create mode 100644 9.0.0-preview.1/.nojekyll create mode 100644 9.0.0-preview.1/assets/highlight.css create mode 100644 9.0.0-preview.1/assets/icons.js create mode 100644 9.0.0-preview.1/assets/icons.svg create mode 100644 9.0.0-preview.1/assets/main.js create mode 100644 9.0.0-preview.1/assets/navigation.js create mode 100644 9.0.0-preview.1/assets/search.js create mode 100644 9.0.0-preview.1/assets/style.css create mode 100644 9.0.0-preview.1/classes/analyzer.Analyzer.html create mode 100644 9.0.0-preview.1/classes/cursor.ArrayCursor.html create mode 100644 9.0.0-preview.1/classes/cursor.BatchedArrayCursor.html create mode 100644 9.0.0-preview.1/classes/database.Database.html create mode 100644 9.0.0-preview.1/classes/error.ArangoError.html create mode 100644 9.0.0-preview.1/classes/error.HttpError.html create mode 100644 9.0.0-preview.1/classes/graph.Graph.html create mode 100644 9.0.0-preview.1/classes/graph.GraphEdgeCollection.html create mode 100644 9.0.0-preview.1/classes/graph.GraphVertexCollection.html create mode 100644 9.0.0-preview.1/classes/job.Job.html create mode 100644 9.0.0-preview.1/classes/route.Route.html create mode 100644 9.0.0-preview.1/classes/transaction.Transaction.html create mode 100644 9.0.0-preview.1/classes/view.View.html create mode 100644 9.0.0-preview.1/enums/collection.CollectionStatus.html create mode 100644 9.0.0-preview.1/enums/collection.CollectionType.html create mode 100644 9.0.0-preview.1/enums/database.LogLevel.html create mode 100644 9.0.0-preview.1/functions/analyzer.isArangoAnalyzer.html create mode 100644 9.0.0-preview.1/functions/aql.aql.html create mode 100644 9.0.0-preview.1/functions/aql.isAqlLiteral.html create mode 100644 9.0.0-preview.1/functions/aql.isAqlQuery.html create mode 100644 9.0.0-preview.1/functions/aql.join.html create mode 100644 9.0.0-preview.1/functions/aql.literal.html create mode 100644 9.0.0-preview.1/functions/collection.collectionToString.html create mode 100644 9.0.0-preview.1/functions/collection.isArangoCollection.html create mode 100644 9.0.0-preview.1/functions/database.isArangoDatabase.html create mode 100644 9.0.0-preview.1/functions/error.isArangoError.html create mode 100644 9.0.0-preview.1/functions/error.isSystemError.html create mode 100644 9.0.0-preview.1/functions/graph.isArangoGraph.html create mode 100644 9.0.0-preview.1/functions/index.arangojs.html create mode 100644 9.0.0-preview.1/functions/transaction.isArangoTransaction.html create mode 100644 9.0.0-preview.1/functions/view.isArangoView.html create mode 100644 9.0.0-preview.1/hierarchy.html create mode 100644 9.0.0-preview.1/index.html create mode 100644 9.0.0-preview.1/interfaces/aql.AqlLiteral.html create mode 100644 9.0.0-preview.1/interfaces/aql.AqlQuery.html create mode 100644 9.0.0-preview.1/interfaces/collection.ArangoCollection.html create mode 100644 9.0.0-preview.1/interfaces/collection.DocumentCollection.html create mode 100644 9.0.0-preview.1/interfaces/collection.EdgeCollection.html create mode 100644 9.0.0-preview.1/interfaces/cursor.CursorExtras.html create mode 100644 9.0.0-preview.1/interfaces/cursor.CursorStats.html create mode 100644 9.0.0-preview.1/interfaces/error.SystemError.html create mode 100644 9.0.0-preview.1/interfaces/view.ArangoSearchViewStoredValueOptions.html create mode 100644 9.0.0-preview.1/modules/analyzer.html create mode 100644 9.0.0-preview.1/modules/aql.html create mode 100644 9.0.0-preview.1/modules/collection.html create mode 100644 9.0.0-preview.1/modules/connection.html create mode 100644 9.0.0-preview.1/modules/cursor.html create mode 100644 9.0.0-preview.1/modules/database.html create mode 100644 9.0.0-preview.1/modules/documents.html create mode 100644 9.0.0-preview.1/modules/error.html create mode 100644 9.0.0-preview.1/modules/foxx_manifest.html create mode 100644 9.0.0-preview.1/modules/graph.html create mode 100644 9.0.0-preview.1/modules/index.html create mode 100644 9.0.0-preview.1/modules/indexes.html create mode 100644 9.0.0-preview.1/modules/job.html create mode 100644 9.0.0-preview.1/modules/route.html create mode 100644 9.0.0-preview.1/modules/transaction.html create mode 100644 9.0.0-preview.1/modules/view.html create mode 100644 9.0.0-preview.1/types/analyzer.AnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.AnalyzerFeature.html create mode 100644 9.0.0-preview.1/types/analyzer.AqlAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.ClassificationAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.CollationAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateAqlAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateClassificationAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateCollationAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateDelimiterAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateGeoJsonAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateGeoPointAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateGeoS2AnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateIdentityAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateMinHashAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateMultiDelimiterAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateNgramAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateNormAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreatePipelineAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateSegmentationAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateStemAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateStopwordsAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateTextAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.CreateWildcardAnalyzerOptions.html create mode 100644 9.0.0-preview.1/types/analyzer.DelimiterAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.GenericAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.GeoJsonAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.GeoPointAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.GeoS2AnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.IdentityAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.MinHashAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.MultiDelimiterAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.NearestNeighborsAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.NgramAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.NormAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.PipelineAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.SegmentationAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.StemAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.StopwordsAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.TextAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/analyzer.WildcardAnalyzerDescription.html create mode 100644 9.0.0-preview.1/types/aql.AqlValue.html create mode 100644 9.0.0-preview.1/types/collection.CollectionBatchReadOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionChecksumOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionDropOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionEdgesOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionEdgesResult.html create mode 100644 9.0.0-preview.1/types/collection.CollectionImportOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionImportResult.html create mode 100644 9.0.0-preview.1/types/collection.CollectionInsertOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionKeyOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionKeyProperties.html create mode 100644 9.0.0-preview.1/types/collection.CollectionMetadata.html create mode 100644 9.0.0-preview.1/types/collection.CollectionProperties.html create mode 100644 9.0.0-preview.1/types/collection.CollectionPropertiesOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionReadOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionRemoveOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionReplaceOptions.html create mode 100644 9.0.0-preview.1/types/collection.CollectionUpdateOptions.html create mode 100644 9.0.0-preview.1/types/collection.ComputedValueOptions.html create mode 100644 9.0.0-preview.1/types/collection.ComputedValueProperties.html create mode 100644 9.0.0-preview.1/types/collection.CreateCollectionOptions.html create mode 100644 9.0.0-preview.1/types/collection.DocumentExistsOptions.html create mode 100644 9.0.0-preview.1/types/collection.DocumentOperationFailure.html create mode 100644 9.0.0-preview.1/types/collection.DocumentOperationMetadata.html create mode 100644 9.0.0-preview.1/types/collection.KeyGenerator.html create mode 100644 9.0.0-preview.1/types/collection.SchemaOptions.html create mode 100644 9.0.0-preview.1/types/collection.SchemaProperties.html create mode 100644 9.0.0-preview.1/types/collection.ShardingStrategy.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryAllOptions.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryByExampleOptions.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryFulltextOptions.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryListType.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryRemoveByExampleOptions.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryRemoveByExampleResult.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryRemoveByKeysOptions.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryRemoveByKeysResult.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryReplaceByExampleOptions.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryReplaceByExampleResult.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryUpdateByExampleOptions.html create mode 100644 9.0.0-preview.1/types/collection.SimpleQueryUpdateByExampleResult.html create mode 100644 9.0.0-preview.1/types/collection.TraversalOptions.html create mode 100644 9.0.0-preview.1/types/collection.ValidationLevel.html create mode 100644 9.0.0-preview.1/types/collection.WriteOperation.html create mode 100644 9.0.0-preview.1/types/connection.ArangoApiResponse.html create mode 100644 9.0.0-preview.1/types/connection.ArangoResponseMetadata.html create mode 100644 9.0.0-preview.1/types/connection.BasicAuthCredentials.html create mode 100644 9.0.0-preview.1/types/connection.BearerAuthCredentials.html create mode 100644 9.0.0-preview.1/types/connection.Config.html create mode 100644 9.0.0-preview.1/types/connection.LoadBalancingStrategy.html create mode 100644 9.0.0-preview.1/types/connection.RequestOptions.html create mode 100644 9.0.0-preview.1/types/database.AccessLevel.html create mode 100644 9.0.0-preview.1/types/database.AqlUserFunction.html create mode 100644 9.0.0-preview.1/types/database.ArangoUser.html create mode 100644 9.0.0-preview.1/types/database.AstNode.html create mode 100644 9.0.0-preview.1/types/database.ClusterImbalanceInfo.html create mode 100644 9.0.0-preview.1/types/database.ClusterRebalanceMove.html create mode 100644 9.0.0-preview.1/types/database.ClusterRebalanceOptions.html create mode 100644 9.0.0-preview.1/types/database.ClusterRebalanceResult.html create mode 100644 9.0.0-preview.1/types/database.ClusterRebalanceState.html create mode 100644 9.0.0-preview.1/types/database.CreateDatabaseOptions.html create mode 100644 9.0.0-preview.1/types/database.CreateDatabaseUser.html create mode 100644 9.0.0-preview.1/types/database.CreateUserOptions.html create mode 100644 9.0.0-preview.1/types/database.DatabaseInfo.html create mode 100644 9.0.0-preview.1/types/database.ExplainOptions.html create mode 100644 9.0.0-preview.1/types/database.ExplainPlan.html create mode 100644 9.0.0-preview.1/types/database.ExplainStats.html create mode 100644 9.0.0-preview.1/types/database.HotBackupList.html create mode 100644 9.0.0-preview.1/types/database.HotBackupOptions.html create mode 100644 9.0.0-preview.1/types/database.HotBackupResult.html create mode 100644 9.0.0-preview.1/types/database.InstallServiceOptions.html create mode 100644 9.0.0-preview.1/types/database.LogEntries.html create mode 100644 9.0.0-preview.1/types/database.LogEntriesOptions.html create mode 100644 9.0.0-preview.1/types/database.LogLevelLabel.html create mode 100644 9.0.0-preview.1/types/database.LogLevelSetting.html create mode 100644 9.0.0-preview.1/types/database.LogMessage.html create mode 100644 9.0.0-preview.1/types/database.LogSortDirection.html create mode 100644 9.0.0-preview.1/types/database.MultiExplainResult.html create mode 100644 9.0.0-preview.1/types/database.MultiServiceDependency.html create mode 100644 9.0.0-preview.1/types/database.ParseResult.html create mode 100644 9.0.0-preview.1/types/database.QueryInfo.html create mode 100644 9.0.0-preview.1/types/database.QueryOptimizerRule.html create mode 100644 9.0.0-preview.1/types/database.QueryOptions.html create mode 100644 9.0.0-preview.1/types/database.QueryTracking.html create mode 100644 9.0.0-preview.1/types/database.QueryTrackingOptions.html create mode 100644 9.0.0-preview.1/types/database.QueueTimeMetrics.html create mode 100644 9.0.0-preview.1/types/database.ReplaceServiceOptions.html create mode 100644 9.0.0-preview.1/types/database.ServiceConfiguration.html create mode 100644 9.0.0-preview.1/types/database.ServiceInfo.html create mode 100644 9.0.0-preview.1/types/database.ServiceSummary.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestDefaultReport.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestDefaultTest.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestStats.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestStreamReport.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestStreamTest.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestSuite.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestSuiteReport.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestSuiteTest.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestTapReport.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestXunitReport.html create mode 100644 9.0.0-preview.1/types/database.ServiceTestXunitTest.html create mode 100644 9.0.0-preview.1/types/database.SingleExplainResult.html create mode 100644 9.0.0-preview.1/types/database.SingleServiceDependency.html create mode 100644 9.0.0-preview.1/types/database.SwaggerJson.html create mode 100644 9.0.0-preview.1/types/database.TransactionCollections.html create mode 100644 9.0.0-preview.1/types/database.TransactionDetails.html create mode 100644 9.0.0-preview.1/types/database.TransactionOptions.html create mode 100644 9.0.0-preview.1/types/database.UninstallServiceOptions.html create mode 100644 9.0.0-preview.1/types/database.UpgradeServiceOptions.html create mode 100644 9.0.0-preview.1/types/database.UserAccessLevelOptions.html create mode 100644 9.0.0-preview.1/types/database.UserOptions.html create mode 100644 9.0.0-preview.1/types/database.VersionInfo.html create mode 100644 9.0.0-preview.1/types/documents.Document.html create mode 100644 9.0.0-preview.1/types/documents.DocumentData.html create mode 100644 9.0.0-preview.1/types/documents.DocumentMetadata.html create mode 100644 9.0.0-preview.1/types/documents.DocumentSelector.html create mode 100644 9.0.0-preview.1/types/documents.Edge.html create mode 100644 9.0.0-preview.1/types/documents.EdgeData.html create mode 100644 9.0.0-preview.1/types/documents.EdgeMetadata.html create mode 100644 9.0.0-preview.1/types/documents.ObjectWithId.html create mode 100644 9.0.0-preview.1/types/documents.ObjectWithKey.html create mode 100644 9.0.0-preview.1/types/documents.Patch.html create mode 100644 9.0.0-preview.1/types/foxx_manifest.Configuration.html create mode 100644 9.0.0-preview.1/types/foxx_manifest.Dependency.html create mode 100644 9.0.0-preview.1/types/foxx_manifest.File.html create mode 100644 9.0.0-preview.1/types/foxx_manifest.FoxxManifest.html create mode 100644 9.0.0-preview.1/types/graph.AddEdgeDefinitionOptions.html create mode 100644 9.0.0-preview.1/types/graph.AddVertexCollectionOptions.html create mode 100644 9.0.0-preview.1/types/graph.CreateGraphOptions.html create mode 100644 9.0.0-preview.1/types/graph.EdgeDefinition.html create mode 100644 9.0.0-preview.1/types/graph.EdgeDefinitionOptions.html create mode 100644 9.0.0-preview.1/types/graph.GraphCollectionInsertOptions.html create mode 100644 9.0.0-preview.1/types/graph.GraphCollectionReadOptions.html create mode 100644 9.0.0-preview.1/types/graph.GraphCollectionRemoveOptions.html create mode 100644 9.0.0-preview.1/types/graph.GraphCollectionReplaceOptions.html create mode 100644 9.0.0-preview.1/types/graph.GraphInfo.html create mode 100644 9.0.0-preview.1/types/graph.ReplaceEdgeDefinitionOptions.html create mode 100644 9.0.0-preview.1/types/indexes.EnsureGeoIndexOptions.html create mode 100644 9.0.0-preview.1/types/indexes.EnsureInvertedIndexOptions.html create mode 100644 9.0.0-preview.1/types/indexes.EnsureMdiIndexOptions.html create mode 100644 9.0.0-preview.1/types/indexes.EnsurePersistentIndexOptions.html create mode 100644 9.0.0-preview.1/types/indexes.EnsureTtlIndexOptions.html create mode 100644 9.0.0-preview.1/types/indexes.GenericIndex.html create mode 100644 9.0.0-preview.1/types/indexes.GeoIndex.html create mode 100644 9.0.0-preview.1/types/indexes.Index.html create mode 100644 9.0.0-preview.1/types/indexes.IndexSelector.html create mode 100644 9.0.0-preview.1/types/indexes.InvertedIndex.html create mode 100644 9.0.0-preview.1/types/indexes.InvertedIndexFieldOptions.html create mode 100644 9.0.0-preview.1/types/indexes.InvertedIndexNestedField.html create mode 100644 9.0.0-preview.1/types/indexes.InvertedIndexNestedFieldOptions.html create mode 100644 9.0.0-preview.1/types/indexes.InvertedIndexPrimarySortFieldOptions.html create mode 100644 9.0.0-preview.1/types/indexes.InvertedIndexStoredValueOptions.html create mode 100644 9.0.0-preview.1/types/indexes.MdiIndex.html create mode 100644 9.0.0-preview.1/types/indexes.ObjectWithId.html create mode 100644 9.0.0-preview.1/types/indexes.ObjectWithName.html create mode 100644 9.0.0-preview.1/types/indexes.PersistentIndex.html create mode 100644 9.0.0-preview.1/types/indexes.PrimaryIndex.html create mode 100644 9.0.0-preview.1/types/indexes.TtlIndex.html create mode 100644 9.0.0-preview.1/types/transaction.TransactionAbortOptions.html create mode 100644 9.0.0-preview.1/types/transaction.TransactionCommitOptions.html create mode 100644 9.0.0-preview.1/types/transaction.TransactionStatus.html create mode 100644 9.0.0-preview.1/types/view.ArangoSearchViewDescription.html create mode 100644 9.0.0-preview.1/types/view.ArangoSearchViewLink.html create mode 100644 9.0.0-preview.1/types/view.ArangoSearchViewLinkOptions.html create mode 100644 9.0.0-preview.1/types/view.ArangoSearchViewPatchPropertiesOptions.html create mode 100644 9.0.0-preview.1/types/view.ArangoSearchViewProperties.html create mode 100644 9.0.0-preview.1/types/view.ArangoSearchViewPropertiesOptions.html create mode 100644 9.0.0-preview.1/types/view.BytesAccumConsolidationPolicy.html create mode 100644 9.0.0-preview.1/types/view.Compression.html create mode 100644 9.0.0-preview.1/types/view.CreateArangoSearchViewOptions.html create mode 100644 9.0.0-preview.1/types/view.CreateSearchAliasViewOptions.html create mode 100644 9.0.0-preview.1/types/view.CreateViewOptions.html create mode 100644 9.0.0-preview.1/types/view.Direction.html create mode 100644 9.0.0-preview.1/types/view.GenericViewDescription.html create mode 100644 9.0.0-preview.1/types/view.SearchAliasViewDescription.html create mode 100644 9.0.0-preview.1/types/view.SearchAliasViewIndexOptions.html create mode 100644 9.0.0-preview.1/types/view.SearchAliasViewPatchIndexOptions.html create mode 100644 9.0.0-preview.1/types/view.SearchAliasViewPatchPropertiesOptions.html create mode 100644 9.0.0-preview.1/types/view.SearchAliasViewProperties.html create mode 100644 9.0.0-preview.1/types/view.SearchAliasViewPropertiesOptions.html create mode 100644 9.0.0-preview.1/types/view.TierConsolidationPolicy.html create mode 100644 9.0.0-preview.1/types/view.ViewDescription.html create mode 100644 9.0.0-preview.1/types/view.ViewPatchPropertiesOptions.html create mode 100644 9.0.0-preview.1/types/view.ViewProperties.html create mode 100644 9.0.0-preview.1/types/view.ViewPropertiesOptions.html diff --git a/9.0.0-preview.1/.nojekyll b/9.0.0-preview.1/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/9.0.0-preview.1/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/9.0.0-preview.1/assets/highlight.css b/9.0.0-preview.1/assets/highlight.css new file mode 100644 index 000000000..d4903f6be --- /dev/null +++ b/9.0.0-preview.1/assets/highlight.css @@ -0,0 +1,141 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #008000; + --dark-hl-4: #6A9955; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #CD3131; + --dark-hl-6: #F44747; + --light-hl-7: #800000; + --dark-hl-7: #808080; + --light-hl-8: #800000; + --dark-hl-8: #569CD6; + --light-hl-9: #000000FF; + --dark-hl-9: #D4D4D4; + --light-hl-10: #E50000; + --dark-hl-10: #9CDCFE; + --light-hl-11: #0000FF; + --dark-hl-11: #CE9178; + --light-hl-12: #0070C1; + --dark-hl-12: #4FC1FF; + --light-hl-13: #AF00DB; + --dark-hl-13: #C586C0; + --light-hl-14: #098658; + --dark-hl-14: #B5CEA8; + --light-hl-15: #267F99; + --dark-hl-15: #4EC9B0; + --light-hl-16: #EE0000; + --dark-hl-16: #D7BA7D; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --hl-16: var(--light-hl-16); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --hl-16: var(--dark-hl-16); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --hl-16: var(--light-hl-16); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --hl-16: var(--dark-hl-16); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +.hl-14 { color: var(--hl-14); } +.hl-15 { color: var(--hl-15); } +.hl-16 { color: var(--hl-16); } +pre, code { background: var(--code-background); } diff --git a/9.0.0-preview.1/assets/icons.js b/9.0.0-preview.1/assets/icons.js new file mode 100644 index 000000000..b79c9e89f --- /dev/null +++ b/9.0.0-preview.1/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/9.0.0-preview.1/assets/icons.svg b/9.0.0-preview.1/assets/icons.svg new file mode 100644 index 000000000..7dead6118 --- /dev/null +++ b/9.0.0-preview.1/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/9.0.0-preview.1/assets/main.js b/9.0.0-preview.1/assets/main.js new file mode 100644 index 000000000..d6f138860 --- /dev/null +++ b/9.0.0-preview.1/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/9.0.0-preview.1/assets/navigation.js b/9.0.0-preview.1/assets/navigation.js new file mode 100644 index 000000000..42bedf5b0 --- /dev/null +++ b/9.0.0-preview.1/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA61cWXPcuBH+L8qrk6wd7ybrN0kj2fJKtqIZe1O1tZWCSGgGNo8xSMrSpva/BySHQxwNdPdIbxL5HWADxNEA57f/HbXyoT16cyQqUTz+IfXRi6OtaDfmSlnnXSGbv093/rZpy8Lc/qqq/OjNqxdH2UYVuZbV0Zvf9jLHgUxWiKaxZY5BvZev/vXni0BmIZtMq22r6mpWbB+3kJ6F9Yr6w8//fPnjK0D+XIq20xKV3uFQ2W8Fq+AgHDM57eOp7lQmejTHD2Wi1nVR8F0TJNRQm8DLifhx4DRxJwhNtJirgugSEGhGcB3QPJNcor1fGUTnCI1mupCFKlUrNc80RqOZvpX1+4b7nDCJbHhdq6plO0IssuXyFdsvoNDMLnJZtap95PlFWDTLK1W9E82G5wiTiIZd0aoDm2uSS7P/IIWWTftBqvXmttYNrwAIm1iEtRYl0xegEM1qzfUKGTSra7U1VVMxx5IIi2a5lOvSNP4DutsEk2jdSmZgAQbVqt5+r3XObKwxGs10Zf7h+QEMmtWvZo6bCZ3z7CIszDLoPigTrBQJM3wrK6lVxrGLU3AzZ3SlmcUoBDNnYCW6xTgEu3lcJXqBBMzIH1ApXgkOZueNphS3OAU1A4dQkifGxKxjgyfFnMBF7e0xlOQZIaBG1gBK8oHxmI0/cFKsEhzMDhowKZYID7W1Bk2SHYzHbbyxkuYVJ2GG9mBJ8YrgMRt/kKRYJTiYnWqOtajWdZiiuuuqbBifZx8f7Ir/9PrP3y1l8a2YxfZps28FLWP2rbjsOy1haZgxSOo7ke1kZoin+ONPbvbp353UjymZAYCIfBZFF6bERv5wDwu0Ew4rtkYiCIqJpFNDQDBcBRuDSXnhAISAeDgyX8x0ICbQ30tQi/RzFJFHsNtVVheFzNz3YWpe8z1SKzvdw5emu+us+ausutKR86Guvp2lnZEr00hIkj0wLji+c6fAY1tN2dL18amWvaizru/s6eohI6V/lq8lXdtFp3Rn1Ilos82NFHlkDQIG3CdRcrwj83Qjs69NV3LcPA7dbKHrLcfIwtNN+qA3HBebwLS5kY2Zk9JdRjzd5KLc1rrlPIzD4BoxHscmMGyqRjKfx2bQjX6RjxyXGc6yuDbt05ROSbLLzKAbXclW5KIVJI8JTJdnPsQhTzBzOJUSsOiG3P7zoK7zRpb1veTZWAyO0bYwQwvPyabQrT5tTeNhOTkM3Kjcdq3MhxkmxSWEsyyIbRtk0PfaRh3C48AMNF+4m6GcPaimJbxBIJ5q8tE8/bBSPheqAHbNAR+fwrYidHBRDmZm+twhlynaWif0bRi6Us82shR4PTg4miipvfpQVHpjltKqWi9b83hy/ZiS9qCotCq3hRzWV8dFQQgJhAdNXoxHSoxILrdaZqY4+RHsfPJ49iD6/1j+PuuppTjviqK/yiqER3pqGS7NC+8u0lLmE/qpruOodlgtwNxnLhE6rcWoz1Ue08sQ+u808TnLckhgZt7TSzLMUQ5tOCD5ucvEixDEfWqJxvnVYUGCuc9cIk6IQOpB5VlpcS91IwiDjg89yM9MDlU+zDwu5b0sEnYeEs2Pa9VPn3fTmoSuC8RkZ+KqNqO5GdOhHKUlHxLSiddoEg9UDwlITrSq4jnR6R4t8z5m+LfKNLatKRUwOO71Aix6FnQgTOj4PNZz8AmYzYloVHbctRuzghh2eUUBNPi9CQRHLfrtTc3wgPD42qy6U+uE6gjAZC5rkZ+IQlRZcla7VwXxmMmN/NbJJj6d26u7QFjWadudbmrgBPZ4ndimtXg89XSmI9g7HQuTOoM9ZI5lTlEMoSnhEXH2YMJtRc/Ok48SNi6ZIR9w/WYFQW6AhWp2NfTv3a2wu4OpIqY7pKq4rNfegDDui+xFJkB8P2QRlGQK/F5kARbJO02fmTA04Oi017EwhGPunxqpz3e9eVzSxdF6zJ4RV9xDULGm/VDnQY8+K4338cP2XWPa0UV5O3QS8qK6q6OaEJhocCN3nCszk8YMHDDXINJrRT2ouTWPBk/9oi7E3QKP1b/L9GgNaOKJ9Z0GGiwIzbNItvcQShPvkbSyW0g0ObdjJt8BG4QJnj2YVZGKZUf3ki6MKHptqhxT7DFEOW9wgfWgoSUQfFe3JyL72m37HEtU0UGRJbFI+kCyMPI2ezj0CGPVtKIollLfK7xDAtH4PHB9VpmlSpgttUffHYQuhpU1QBKkhyH3UtwmxmYHRZVcyrZ11nYR0R2OIHtlJghiHe9wZwhBbFnrdqG0v5QLJR0g6QTp7nVEGm0IJYnv2uFCbmVlFjdZsLpwDQI4enJS6AYbPS0MJjfkVpI99h5Bkurbdan+MMOqmRCnNR0oWTz1etkgkuBKm24p9RI4KJYkqawemGDQyZUq+9W/VllS3AHiK9Yh/0jscUE0fgR3QI/L9A5OWe0dIDDRINmWLQxRbtmVpdDxl9iFEUVXZtG/kHfCvJ8mlqb/wuQDAt+o/5Nh0//JMEnPf3wgS9hMQ0t6lGw824YaoxnNsehUYjHiA7nCjAjNcK4JOT4TmGGwElv6M+zBDIP/dJVivG4WnGtCDdMejO+VV+tC0qYtAJYmT5+4RPCozXexXkvdf68Vl54xmJwZO6tGjKdK91sD8T4IhjNMFrIVKkxsQwY7KEMcG3JDKCb+qVKsZVQEj9ps11rk1JkDiEYtGqmt7CPqAcIpJhRlotxnqRvVH0FNTEYsDCY37YGF+d55y2yv64OT22X57nSU9dT7ZPZ0i5TNno5ZBY+7V5kQ1ENeC2A/LFRbEDbBJmxsly1UpW6vTfil7HuU8JxYqDwh0cRSDqyk92r9XYpCOoYTgqKEx85GYYofb7+YKPyq2s1FHle0UXTFX2Q4dAGSBoavtdtsE9cabuO7dlJraNNuuMzYhz5zZaaNnlHGgqQ2et617TapswekVJaPTStLT8faTxulLFRqc27qrTy5uV8b1RxY8ngBWLpQLlo8r4O8qx8e/lqKSt05s7qpFvvb/51uk2ozuQJ25Vjr3/jEzRWlT9jOVZjCcbV6BKpiGFdB/EA1C4m/VmYmsd2EFTJcJlXEW1dgehFGgbehjPsSDIDYN12AVuqDLkDZTA7Mv0RtH5zc683zoduXd8qsPuJTz1E+hka3V/PcLxTmE8HTNrSGMCQdQhxp/Nw/OKzqYniKyeIeFPXh6YifTFnN58BPpjxu4sMZ0Ivx4UzATHw9E/FifD0TcFOf0ETsOJ/QDGRopWBpUxYJO1dGI0sxqEsSrxedB9rRwoElB1pzTT6E/flwmbYCiR7LmTX+YoFGsdcvf379jx/sKQT4tb4lMd6PsfMxf5pUmDHRMgxB+9JAgR2FJgQeUwms7XY3SHE9q5pO9z8Md9GTIg1qEgTBaL84kC6q+34IyOk2EIPmdZUruo0Hpjlc96t7M8WsWroRzKH5rdqCbuSB0R5q/EmnC/cNdYVtDK5XI1o1SScpQleILd4dJeq63WmTcUULxFI8V7KIDbOguk1gOX0ws3CZD3SSkYU/1IfzXCGN5XqtVb9h1x8eYFtHuCz/pWlK6Y9ZQeuQhh5K2HVeMfnp/lMyNpPWYfmaD6IMlpmhYo9C8zVu/xkT9WCo6ljdaUkLg6b9d51vTGu6jy+Bv9S34dBuLpKG9fc2eVpU9uT3vkC/gLRtdd21wCxruEyyvnEFJvNR4CaU8QvQzrshYTGsm6TCrCCxqUi22Com7C6wLdjxbfwnOCLKNoW1A1aWimnlcBhe/g8EJU2gnwiKLybAuphnvrYHQElOhe+V/B42lv4qqZV8duhT8xjonwMNL+MylHMphc42PTbV9VtZ1EEb56Zyqz478QNqoBvnF/M96qWqvpI8euAh4pG2HvWgJq486pDjR3+EBHSFqewCRL/rh03J3/bHmayH5D7fyWMrm+Ms68pTg66nDx6vzV9h5nqwTDJAO+yLzP5nO7Rsmth7YN2npR/9qKQimGTQ7EbacaFEQ3ODCTQzmgNDNnqqd5AjH+XdLTgp/RoMxY/1OEHDTOJwplFqGQ85cVbyHnXoorh+AekQU1pvQ2Jy7dMdahR9sA3nAbnPtlJSU/vRCBY9ykJo+8wGz2wFh1c9ob55lUyv2YOqc5rUurPNeQI8KNsgYMr7+/8Bnnx0CrRpAAA=" \ No newline at end of file diff --git a/9.0.0-preview.1/assets/search.js b/9.0.0-preview.1/assets/search.js new file mode 100644 index 000000000..91b5a0505 --- /dev/null +++ b/9.0.0-preview.1/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8ydWZPjNrLvv4v92kenCO7z1ptnek4vnq62fSMmJhxsFaua01rKlNTLnLjf/YoAJRHJTCABgvJ9sruE5Q8mkAB/SID/+0O7/br74S///N8fPjebux/+Ip78sKnW9Q9/+aHaVKvv/6nbH578cGhXxz+st3eHVb3779MPi0/79er463JV7Xb1sZAffvi/T07lZMm5oGb3tK02D9unsMD7w2a5b7abQZEwLVLHkx8eq7be7IcSL/WKmzKP0ksrTgX9VFf7Q1uf695/fxw2BSSbXO3z9lhQfSr13aNsJlU5mjiQhFd3xwzN/ruTFCKTs6QsTePsLOj337vK/Gv+8VyAWYC5qIG86EZcemkQbYsAAhd9Mwmd96qHTrDgSeugpBn1Prbbx7rdNyEUa2WF1YyPnhf1qlk3+7p1Gj5UriuMH2PVjgOIbLz3COKocxpCZIEhxhBLresg8lTMHUUsze7DiK8aH0dvDqt94zeYjFmvMKLs9TsOK/Oz8B5bbJ1OA8xcaohRxtftOtSmaOeON75690HnqH/Grj0Q39f7X1HIVgwfDmGQu1MJMxjk3KaFVssczeM6zNt9vXZyk0iGKzhHqlZHl4i11tsRWjQ5uT+srBBOz6bR1dW56+Q6OJtSd7fG0hq8K05xYbRihuNabZfVKrz2xbnccE3gOqe329bNOSEZruCcqFodnRPWWm/nZNHk5JywskI4J5tGV+fkrpPrnGxK3Z0TS2vwrjjFOdGKAzknD+2OzonVBEuXWVa7GdrRl3q1VlTLZVd28Hacy52zJcRk8dBWjrMFkuMa0wVVret8gTXYf8KwqHKbMbDCgkwZNpXOc4a7UvakYdPqMWuw1IbvkpPmDVozY+JYV9/CS1+oUgPKt3SZdbOZoxWy1Ou14vE4rur2S/2ubR6aY1kzNAmpYtb24VPJh/rb3mkmQTJcYSKhanWcR7DWek8jFk1OswhWVohJxKbRdQ5x18mdQmxK3WcQltbgXXHK/EErDvTe4aHd8b2D1YTJ7x0+7XB57wjRit1++/h1294F6/eXpgyLvn57fq72n2ZsU1/81drFeT/0aZDb+2EYC9Xr40LpYQ7jnEu+Wmvquwe11gnfnGHRc7bnKpPLpTWnP4k5mjV4aL4r/zCNc3kX8Gug7Q3H9p4Wqp38N7dZ2un2DhSo0b5vRaGeALF1XD+sj9VWXbluW8h0xmtsJVtqd91SNjwF/61lnka3LWZDmUG2mpmanbecvXWzt56Zyj22oF20z9aVJ21JW1vAeAv7eCzq82xNWZyKD9+gye9kU5rl8m42sVXEqYI/Vk5+fZz+Cu6cqNTRiyNN9XbeZkVOPhspKoSrtih09dDOKrmO2aLT3R9zlIbuglO8L6mX4XT/ONTt99t9a333dZe/0MsO1hSbu92uVtXjrv55u2v83ZHR5SI1XKt1n+v68e1hZXmj8GjUoOBrteVjtV9+um3+E3zgLIYlX6s163q9bb+/7iJvg7dHL/taLWrro4PffJjBsy20omdsD75k+bl5rFfNxu1AJJHpCosXU82OKxiq5d7LGIY2p7UMVV6IBQ1Hq+uqxk8vd2nDUey+vmFrnqWrTlnpmJUzljuPfQGztGIxKD1sc/jnNPqdIDfSRuS6yokNQ9XOxzaIxk84u2FX53iAgygwCFrjqHU/yuGlmH+eg6HZ51AHV/U8XXba8Q6jdoaTY26f+zbEfQ+d3yRLt/pUW/aPvNukSp69Nbjbft69UDpvkFC5ruC2jVU7um2y8d5um6POyW2TBYZw2yy1rm7bUzHXbbM0u7ttvup5uuwUt23RHigKzbcVjqFo/MZwXdybZvO3avfJycHhea5xyQJdsevtCniz/a9VsCpzu08BLy6EW2Modb5BwUct++oEu16POxOYiufoopNuSTDpZriy8yicoQ2LQeFBG2PpSJvDuismaD+6NGpY+sytItagXaXNfbP0WIiasl5jNWqt33VJanwW/utSrk63xamx1CArVLZu52XqBO3stSpbvceC1U3/jF170tKV0QrOIbztXb36vVtodhlnbNdiVNMczbR0v/328XdLtNK0Rp4q+DPa9uk4hj9tV3eztm9QyXXaSJwIr4/17fZv6+bh08dt64bOLZmvcU6cocD1yLjlififHudrdTtIbik3xCToot35ePkk/eyT5g4t8Dh07tqGWbv6pKPorJYEnhAnts1zSnRu6vRJcWpDnabFAO3DJ43fmtXdsmrvnCYLItMVJglTzY6TA9Vy70mBoc1pMqDKCzEJcLS6On8/vVynz1Hs7uzZmmfpqlOcu1k5w6lvusNP9qBFz2YshsWHbZClQ/GQnW+zXJndhFbhDvuv9fbvO0euhee5grs2VOzorYlmeztru7KF23gkCgzhrBlaXX21l1quq2bodffUXMVzdNIpftqom+Gm59LvtBThNsLSgbYTnZWpOZeyZ27RtTrYqUXnc9EzNe385Oij7s/r1WpWq13Ofg9qm7OxtiMQzeZ1/aW2HE4J1uZLbX9mm6tv12zzpbbrtplcVf28bTZu16ARma6zriJrdl9YoS2fMh3ZtLnOPWh5gVZWVq0eSysPvQ5rK6tir8UVT/MsXXXi8sqgnBOsVu2b/eFunlYsBqWHbY6lO622m4c5mzUo/qrt4q4gvVrlvoT0bdPVhtGURaRT46yryGbDW0UGaeViUN2szQ21jgzWatdF1Syt5q4kA7XafSkZqNXkWvJWuC4kRzmus4rEq3VfQo4bPGX9aFTlzuXGxQVaO5p1eiwcXZU6rBrNWr2WjAy14TvlxMUipTkUiXPW7vouxGhAoDWUe1PcF1BerblOp5qydOI3Kxh9m94+H/bm3tBQK6YQ7XVfLoVvL3etFMa+f3p777fturLcK+PV2nPBs7oeuOL7a72p22Z5KulFvVu2zaMpSorOMeuKz1Ite8VnaDAVZ9D9Z5KqRV+Et7SJ6z2mSv56z0Up7HEOXS1EH4PVww+/M2QYskyWM/pCLEOPKc9kQfh3axmqrBknSxt+q5IhiEg+WcbwK2gMGUTy6TKGn9Dh6CDSTxYyvLWaoYNIPr13IFeqcnqJOdtkWYPb0jgeD009WQS83oihxJAlwEAG93awRjOdZ7Kg0Sl7hiBTnuleWD9TynG/ZI7pTwc97sN5RLaM050gEVbO8Yf2rJPlweBJhixDlslyQAwCa7FP5QghRqPYPDVUlhByLi9UPC1oemchkShGa+NzpX0p4yWxe3szESXES425lh95by9PsWecXNpWf2t2+x23znPqibU+1HtulSrpxPqW8u2cW+U59cRa745v/Nw6+7QeNV4i1P+44J719u6w6mr7Y4X0ycG7/qXvNbvjMucf3ZXU51LuD5ulZBiynEsCSzc/6qBreN29hwy++ILU0SfxrGX4GPTC8YfBKXNlFL2apPff28HHjfSCu59cShVpNlzh6sY8eui6va+Wfa/wseX4ZnRW6T+ekpJ1nNNTlX08/unXqt3x6huk9q/yn93U8i9ehZKu/O5aHTAXHBnjGj0GBvLi82u1OozQmapA/uRU/MXFHhfe9VKbm09O6PKTgy9qq83D9vm40MsIGRQ7Tm9uxEAsWv/l9w9bcPk/Wv84vUf9Wnegmj/oFIP6A7SehqsOVZoXJYbcAyGF9v7XP9Uhgq43h7UmRU/n0/bLg3/x7vkvb16+/fD783evX798/uHVu7dOFf+IF2B9IKCtqLaXL/760lvXOLO/JsxEt/tqf9hxNKmU08z09uVvz969Zz2CQXU/XrI5NL5vGarjl7ev3z198fKFq5BBvkBK/HSEVqHa9ertX/0eiMoYSMuLl69ffnB/JJdsAS3j8UTCPA84//9P/V1uE1X7LTzKOihwmMpnJoNk8VPV3h0nxePUeHyxevhOVwxThqi8WT+uarn2en18e0U+1zGsf5w4gITjsqq5k7QN25QfVA8SBqj6t/a4Znz32JlyjE0GNevpAlT8Yrs8dAj/XOZPVbM6tIZnT+XwWcrZt7C5Fdu2sBnlUKusum1Ng5Aja3Eqw1ucZRNblv+m3u2qh4lPcAGKmlXx2wP8trOXWlVMQKXWUfKm3ldHD1A5qD9lCTBon2/Xj4d9fSffA3+mokC1mQfNMPuQNdXrMGKp9vJjTtw0mUNOGGVZuv637hvHO6Oj56jUyplJ6/ZL3X7tJp1pUofFzKR0qXK9m/hQh8XMpJT4+J2jUOuX7ibrvD+6x3eb36p2M/6soqNYWFQ4xdhutCrD7qPHaa/gEdEqnZzhqIGeftCkxMEFjoox96qH1fZjtVp9/2XT/HGoX8HLOfkKkYLCq93pvMRV4zl7eGVT+pn52IGjKnoEHt9PeasTNMMVx+K4Xq8Bqbd3ot1ITR7G08sy96vjkNp+/WVXt8dMnkY7CYVFzaS42SzbultrT1M7LGYmpdv7+109Uea5jJk0HkvdY3tPjjKHxYRTOqJGy0/1uuI4GZhydu+CVujgVkZN8/InJhVsRzIqxNyD2sPo+z9cRX3W0IpWZp5nlLQyHprx17S20RqjqjUf0Nh10TO42/T9p8zdISZu+yhTCzn0C/MOqhagGC+Jln71tWr2P23b2++b5QSheilz6Pxcf8ePx7vI1AqZQ+VODp4pFj8VMIutO6TyfLtZ1q0Re9iMrRczh9LNYf2xbt/dy52jKRYfFTSL1bvCuetfyvCDMubQ2NaPqz44/KdqadwntGrFyprtubJ2GHmPVy9qDsV3ze7orD8e9rXqcK+bzxNmpQVR3CzPel21+79vm83TfV/llKeNFTab6r+21eOnYLJHpc2heznklVPcxqigWdRWx1np5ab6uKpZ/I3SqhczS384LkCefX9ff2ls+yW2rgALmkNts7vtetwEmZcS5tH3otl14crTJA4KCaTSuMPJWCaOU193b9Pl/iRLGQF2NbFbE7y2NHn3EDnvZ2L6Jmxm8lS67mRiIv23MXkaXfcwMY3+G5g8jY67l5hE761L5g1eHvuW6BVekzYtSa04w7Q6OS3Zleilp1vTWzSBEmJWcUOEvB7D4oOYGEc4yFPDJIOYHmcsyO6l2DzuxW+uNz+b654ICi2925vCYVYNAON4PW8iU0CHayi0wGuBPxFDH3wAMMbT7cMZMcXTcKPTKsXrXdewYpn4ysvU7v3miyoP8ALs4YGff6qXn3eHtYP/BVmu6H2xmr18L2w15QGa/afTa773ozk7AFCYv1yb3zpW9IIZrGYT3JcTUivdF18cO7JDPxwkv2IfhLV69b9hS2n+8323rw1B7VZNi0EZfuIcI7QcjHdJfd3YrMmmGzRzelSW8ydNbAWFj8fCJE4LxuJpdY3EQvu/dxgWkwO5xGChEMgvAIs/OtVn4s957QMUzzD/GDXU6zJMifZOerOyS3N+qyKKDBDlwBDrGOjgpdX6DsLQ6fD+4aVxYLT3lzfLYB1BL3OmNtSb+227rN87vGwzWmEodaZ2sGM6GOo9wjr8+jgjsoPTzZ2CO7yUurAYhmI/DuM3RnkMhjMyXfmLf5/gRaVwu4ZrYIqXbsfYFIZ27/AUv+fuEqHCefJ+QSr+2tlxKlzxHqEqXurZBI8h3IPe+WnmkTuOYldqx9VLHRt/Ke9jtK4D0eRXu1ZhXKvHnQp6S6m3xPs31X75aYKkxaUIP2m299j7t9tNHUDlsJhQSmma876u7hxwziD5FXkOrNUL6AxbSp0zbatlfX8wxilYNC0GZfiJ47CdF027/97lmaJ0VNIseq0j1y7UYeT6KWSMXI5Kp5HLVEqP3GddTY7DF+a54hhGq/YayKOGBxspJo2ThsuoYAc7v9rs6nbvYGQtwxUtPK7Xy7x6e8PESpDS/OMk9CItK/9mxQTctNBzGTNpbOv9od28rb9OkzksZlal71asIW1TqoqZSek59vPNdvRhbUe1sKiZFK/r9qF+9/Hfx5yevuYSVqaVNFtfuG9Wq1ebu/rb8+4VbaJorLiZlB/t2UUIOB1ZoYUjpYXTbXp7eFwdl7tOLxDDHFd9hxhV7PkaoTU5zPxEi/OfoECZoWYog1SfKcpJpdMcZRDqOUk5aW0eNtu2fl9/8R0W5/eKYUHzPlnmnGp9ss6TqtuTdXmjpB+r30ul0zP1mJuMz3bS5OSk3Wd2MkifNj3ZlNPz0y+Pd9XeZXrSMlxxdhrX6zU56e0NMzeR0vynJr3IUDMTLdRnYnLR6DQv0TI9pyUXpW6zEi3Vd1Jyf6rMOcn2VJ2nJBelnPNtdqFuR9x8dLq+3dFa/d/unHorf6Y3dFWfid6tn3rM86b+Ommad1HuM8vTwqdN8hbdpnfQ9faL2yvoIMNV30BhvZ4voMP2hnr/JKRNef0cFhn07YPS6v3ywVfq8p5MyfR7TeZrdHo/okR6vh652Nzr7Yi2/cSXI6Nyw+7M+nHrtjszzHDN3ZlRvX67M1p7qdP07Xb9c2eRb5OULbRyfEXa7kTehlA6KGUmnay7KOxCHa+j8FHqujdHavXfm3N5rpsXBxXmOvXJagXNpLaLnFvVU6UOSplJ5129r5qVp0M8h5aeCwmnkvbkL+8enK4nGKa/oh8fVevlxrXGBoufoLRNip3QCrXac/CZr2ffX36run9ZjWrINP+tKZa6Xe5QMbSdWs9+bh4na1v0pUwRaLttpVk3hmU3V+ipmBmVfuyWzbfNf6abfDEsakbF+73pHhumVlVIWJWGsf10tXIZ1Zfk1xzPoFa/kTxo6dQxjOvxGb2DkkKNW0Kcz4hlq3Mbq4RC31HKVskdn4Q+95HJVrbbt3VluLmA0fdOJYTSZ/AZijB6rQrwrNf0JQYFfn6FeBreOxxOWp32OuwlB3gfdZPv+GY6tQV8L8rQ7uNRvVTzdpvcxLvuO3m0weBBFCX08iB41mt6EIMCPw9CPI1Ao9Aud8IoJAoPNQoZ2n1GIVe1sQfLUBrPLozm9ejDjCHWHZT3GV+DfH/G4ILVTxtZw4fgv3XGl+m2g2Ypd9pGmoNo/n7aJMW+DoySPd17GbUbxthPx4XXvv5m37Wi81xzbGFV+40r2HDySqq72rAfxJO2OJUyQWCwCcmk02cmctPJBhQmmR6UwqoSjpEPbdUFsVR2tgRTzj4e0AodRsGoaWTfN3Upk4pFn9VZiu1q9uZoRMNNNkZN58yhVe22pm92GDX1WUMr6m4cNV75YxR1yR1aV/3tsTq6Ql9hg+yhld01bT8q/aQN84fW1uzr9bvW/7EN8wfv+9ZLj8z93+GWI0dl2wlPbDvT0zrIb41v6p3rdHISphUQQF24iWcgra/mv6IJGoctpSNW983SFCzmqncxKDKAcJsz7DazA4o/lTe/8nWzeVE/7g1hhUbxg+yhB9i6+jZJ2SX7DMpeHZcflc9iciBPKyOARls04/t6d1jxrisYpL96LOOg2gmhjH1jqfHatrwvWlCSFqcSPIXZ4sHkPWO8mxAohZcy5tEon4BDKBj1EL0CwXgK14971odFaYF9CfPoO8iti2lWvpQxj0Z1ImyaxksZ82h0jkpENE4ISqQ0WmIS+e54kPzaEYlTnfGwpX5rJ6sg/mIJL8r2UlTxDtVR6k4FhFIX2JxKn9My3yS0by71MJfVZlPfvTKDWFfNC1BsgAaw2BXPKzLbMChyFv387W+bX7Ll/BM3v/28lfVRkNNOF2zvtkNHCl1cSpsseNLWsZP5sazXtT+pwLcDoE+D3KWVqbldwKZ1MShvuugpQXQOnQDN+SeG0E3uAvij8F3Cuwh1Wcxby/WZAbqdZw/3f8n2Z8VmBHP8gydAjvkupXtcBjrcT0VNkzr1FY6v2OFNborirUfcC6J2OynghRxH6aW7nu7pvqzIzrqbzXE9d390y5r4cQavOKukGOzDdVeE+1X74zmz9SEhLSUEPQw+qeWm5oH3LS2+FIXAPNWcMwcU9Hj+1qenKK2AkE9qe9j4mu2UN6Cctl5Wq+VhVXUfW/BXhhQTUOR983BovS15yR30uakPlHo/r3P2kH2r/6Sob/e6ZA8oarWtFDDwNqBeQlAjyv/xNWGfOaCgfXvYLP0d6SB7QFF3R0/oKajPGnbOOy4XHrebXfNxpb6Y5D8HIiWFfG59yle+CrUCZhD2csqCZlTIDAInSptH1NQHFvhZ7aovvu6izxpYzNPBITd3PU95R9pcfLxENt5O/pQ7vCT/B6UVEFCYoiKeos6Zgwvyf1DD/EEN2L28ehuvzxxc0JQOdckfUFYjd209NZ0zh1yLHucq30WoyhpQTOVtriq0oarNd18pG1bUBl/KxxNd9RQ0zB/0FbTd7acpA0UEH/7PJj65cSnh57zpGkfFBJ9upmoclxL0bXr7+fCouKn367RWxAz9cII4UETIEdwfZvIdvZfsIWfISWCkmQOK6If3PASFlVNvdoe2fjVBlF5CYDAyRdgwf1DCvH6slv6M+ZR7miT9q/X+mC0MZBvsJHWRPOxdJD3x1B0kJtdAKnViGqCFE3mGSQ3L9fDkMDgGpoTLMPgi7G9RlA7m+xNPCo9bYFIcmIWTFL8H48YqeIJYnAITw2cULkL8HowTm+AaisElcCNxmYSLEN8O48AieHJYHALTwmcQPCH2V35MBfN1nynB+qqPSuC95vMkcF/xMSFOr/c8OQ6v9pgi19d6niiH9zxMlOs7HvNJ8V6h0Kfk8PrEE6OfZuArYR9iYPoWFRru41zOOQNJ2R72vloGWQOJ2Z9OUXqoGeYN1Vs4e51od2Hvb/KE2IO2MBXMgC2eBFawFqaCH6jFE8IO0sLEuAVoMZ8MIwQKfTDcmCfu8skpKAtfRbkHZHGnS04wFj5TsgOxuM+JFYSFPx9+ABaz7/CCr9Du4xB4xV0+cIOu8NWDU8AV11gMCoSbisuAuDMTK8gKn5j4AVZMCmMPrkIBDDOwij0nOQZVEXOUT0CVG62yBlOZcBUvkMpNECuIyiSKH0DFHPr2PW50zDP3t10AAHcnjcYATrtoTjRrmjb3XUgXoDRFm8fuo5tJPd9IXTf2uG9fvnOcw96ZgxRfIQFfdNj7ZejbjtteGX+O8xXktEfGXeRz9sfwZT57b4yU4rovhumYvh4aPIzNpv/5pGO9vTuspIjTT8i+F33a8fVx8fisWlWbZbN5uKVuujsXjSa3bbSdNdMynrbV5mHbL0jqN/W+OvrFitaBp/cQwjpmyanWfr7SUorbnUwOkqx3MtnKstzJtL2b9MQWfQHB1OF96+ljc8pqUztIGqBrP6t2zfLpYf/peVvfHfM1FXIlz1kBlnr2bk1W6tCp0WZSp8N3das5U2dFi0ERXtIsnfrxWOTXbTs+bstXOCgikMJRz6qPRbX8roUln79vkbW6dC60pYTt9tvP9fiOW76gxakAP1l2u72v/zjUO/I++nPxerrZLYVU52Ai0CjCNut6/2lrGFW0hsU5q6MU20fRtneG9Y5BT58xrJr62+Mx27NmU7V+qkABYdU1uwnKBpnDqrJ8uJWjjf3BVj+Fbb1vv7/bPN9u7lfN4F3GReK4jLAaPx0bXiP3VnK0XfKG1bRv1vX24Pe8LnkD+4tqV/9cIdfvsnzGJXNYVY++ih7nULM7zotLPz3nrJMVja+Z3Nw3D7Qo9fvss+ygGofZtRdPPO/uPajrWm+Na+pxzQuQkSnDdn1rO/5uokmESh+m7upgGgdI5X2GQLXL18dfj65wSGhYMkDOMHpWbnAH0UWVEEbfuvr2/jitDSMKOKK0bGGUPG63K/TLuCYdg0xhVCw5r3GIED1fGC3dJ0urVfPF7ZEMc4XR8bG+37Z17+ydtMCc3nqmOnhdyelu09hZEmgR5YTu93VrR12YEwI5/7wHpinhXMJLPDC9RVNX54hQj1U5q9dbV+OIFodVOM8ndlFJj/tDW9/uq+XnD22FfYnE6CCJEsLoa3u7/uNQH+oPx+X+rdxDdZNoKMRb5WC/5tDuBvD+vFcj/2zepxmcgXouk7/8dpx+8b1TVdwwmWUZq2QRz/Vr1W6Os71TVT8OMpnq1HKSHe+43nCqvM8wveJ2e98Q+/hk3ec8k6vX71TnVG65RN1Y9biH3bLql6mm9K9ltfxU/61xqurHYSZGa29N163Lst40sgxXCedsk0XIJLvn4IsmHB0wZyAp74+v3msvKZecU6V8bZt9vXv5rV4eHJ/KKGcYKa/AJbFsJa9sV8KyhfTX+Hef93SRoWcLJIIODDGrsASFsGWMvjDAkGD/hAC7+se6+vymXm/b77/sqgf7RDFQMc46VUwt+/pxIdItW1ykwIyTjXLsYnTkO2WVQaapAj7t94/9W5GTRwf5psrYbO/cZpRTBp+KxSVE6lm1P85Md0/btvr+XF9x9iWfFIxTOk7kIhNRon+2c+dY2Y+nTMZWI20iVdTd0sZVxSlTMBX6aRSmCstRFHcVn6rdm+O846rjki2kkrfD04d8JW+NJw85SuDhiuHZZqaOS7ZAOip3DcajxK71bzyMsQlqifvjW0g12BdiirhkC6RjXT26alBZQj2HVbV/467hki2QjuOa6LB0dhXnXIFUfG7cB0afJ5CCf1a775ul+uzotv2Xq5jftey/T9I1nNYZ83mwifyjFEVO5aM2X9Ib2zp9+vabt6dP2H4zdYiJ0XdGnDYF+cw9Eycdr9lm+jTjO79Mm1h8ZpTpU4nvHDJ58vCcNSZOF17zRLgJYurMQCgZhXmc6z/tJ5x+MO4oZMM4PhXo/gIWeH/YyK2NQZEwrXmeOUuk43A+HIvbVbKay2kXuGlzrh5P7SyCsSPJqdIWsWMpgyY5y9VhN95rd5C0GJbhJc6y2yap5gR9p/xzaGvHcZ8u0lpTzKezMkN/xyO+sRpYMd/h+rlLzLchvzFC99X6cdUsG7i/zpSzgGU4i5sSRewk0h5H7K/ya9Xsf9q2t8dpxVOiXkJofavt8vMHNGqXq08vIbS+dfVtkAeJ+OLKRAsKoBZ6D/n5PYvfGKaZ1WOMKmL7Cq0Zk0YgpcF57GkFMXxDF3IIgyeZqk5ZwynCI+PtcmxR8T5azPFTdk3cGCofbfo7PleR+V3fR4fkJSZ3Q2oZ5gz4XLpYBvfn0ucKp2Mtd0RfN2t6XUCq0fMG1FR9e3+0/3BTlS1pmDXgaN/DiHrGSN/bpwEXDfdVs3q3+U2FeTmrgbnD6YIxW1xFtrgtHy27/fFVYu0s5ZwtaB/uH/buuZcLRAoI2JdGAQPsfmSNGvDS06xWz7qF53MvtzjKHk7Z9phqfXT+8AIIu6hhzkl6QiwQL2rswdwmWYNWUYuRwzgC2Efe4lTQFJH2QfrzqnJY1w8G5yljUJfxtotH+blunx9XrbsuYttHGVZIUJXMFziTRudXNweFMu5nXd81VXeZ5/q4OvFzdXQ5c2r1eqJkMQGn1s/N46tNtVzWO3lhIQMd0/OtsayAmo+PY7Vq9nUHW36rPJa4WAmT9EG88PLb46pqbGBSTzUrYkCqYkMG0BjfKZWW4DKpglImTascRQ4TKypt4tTqJJE7uVqEMia0w/pj3b67N06zBulIERPNDrmSr7JB1omKDPsVL+r98b2Ns1/Rp7zWfsWwOp/9ilPDqGmRw/8RDYvGjfmfirC9VVasnTdM0ClvAE3E1PHz8LAW3n+7JNeYNM71uM4Ysg2soG5exQtzYDea3cJYGb53pMLNyzJULO2LLkrL0mWNxVf0pWqb6qPHsxlmDKam3h1npu5Q1vPt6Ky6VRHMHF7V2/aVFq/vKuySP5i2Zvdme9fcN8uq6xpy7eoqDy9iikLC0+nHI3F1jMORYXzd4BSJo7MzHmGRLmN0/I4pYQFzOwji+L/b43vbo6+sS+Zwqrpzx6MTnFxVIHNAVcQhNbYw5kk1H234mTWuMt7BNaYuOMpvm83Dqu7zvK93hxXpwpGks455qj720Mfaxjl876ZjYTyHbyyFsVvZzda+woYFBFc3ui/BUZz16oQJ2namOcsmzHy7gJsqONreHFM1rME2TjnrWCOqYw81pGGm2cNPxuKR9+6PlDJxpFl0OQw0Z222cWaRxh9mzsqMo8wiiznIOJpGF5/v9m/Hl7Ofi+x/nnU0DetgD6GTbioawq2+hVOlNksfPr41AQGs/kEeXw3Qsj9X7a42u81BklktDOthW3nYBspDdknIlTVR8+Kciy9gOvegxDhxD76ij8c//VqNLgizyhnkC6alolkHJaPiEA6jAjJOVu4MvD8wIoLOKa8TM6tX5x45e2kYRSorRsQaqmLRZ3WWYourWVX0dG2RdMobQFM4cylVPjEsUF7fPupCk+bubvQNAz+Ni3NZ06TaXOTqsNvX7bvNyh4jzZKtFziv9mrzrH7R7Lp1qz3unKceFDm3fsWRnt7dNd1UU5m3FZ2bQpU+a6vu+qf37PuL+r4yrHTcmoMVO2s76i445rFtdnW4wTEqM3QL0Om1u7/zsy3695Ro/klVq8ltPj23hLSZ3Rdg1S8uGV1k2AMZZPLbfXtM/LrePIwuOWdII0oJq/N2tf3aZRlf6c1TqOcPqG3XF/z9w6e23n3arjyMi5YRUOO+S/bMsrKn5cHsoZVNsi1SwjR9Rg/FOTAH0l7PX/kfoIPNC+C90G8IeTkxdvyuny8jwrOmujS2atfeT+j1HwLMmFM/P4cGn051d8zDTc5eDz3uNMH5OegM0QsmukK3o8OvNvdbo9Iuwfy+71yLm8OT6p2D9NAaWbF5l5yWd5PTI3FSMMgVSEf3FUw3DX2OQPX/YQrYwQWcsgRSYAOhuAg+BuXq2O2r1hAFgsu4ZAqkoj0YAytwFZdMgVQwA1BwNc7RJw4WosNoSftwomf5CqzHQxEJDmdDcQ2jD6EpsvZq/VF+2Kk2TRFY2llnC7JC9sSBNo+6rkR+MsVXy+Kc3UPSNEzNlOZAqg0aT+2k9uXr5uHT/hfDTp2r2oVW5GThtoVd1T7U+99klcFaAAqduw0beUrl9lPV3pFToXMbQKFzt0ElenF4JC87cG6BVuTs/Wi7r1ahu5FW5twtaE45g+kflniV5x94COhlzt2C3TTxu+k655qOlLTTcxXTnmXfTuohNv+pJ01GQOtiUOBk0aypyHQG21m9VuTc+oNMQ7AFw0KnrmR4VugGfdAuNCzxKuoDm2BQ5vUsoOr7qd2ub78fi1szjvxPaRhV0dxtnT7pwkadS5zLVsQb5fu6L+PW9KqNJnZ+p7RJsOwAEcmv8WqL1un6djtqJ71x0awP69Mh9jfbLzS4ZuhbEOX5iWa9Dzz/VG0epomGBc2idn18FK/Rr7a6PWCtmNmU/rTt7qUMoHVY0Cxq5b3Wd7XrFGAUbihzljY8Nj9Vy/3WBpqMmgdlzKLxlH33Uj0c2+LHKBYrLJRqm+fvfBJXe5f2qj7/XKG3w5fNo+Jtj0sYXyWLPrOHHOtizluTzBpekVzXeIs65Q6v63JYwFucVkR4hc3uNQeZ0/oGBQRRZ/MG5kMyeOqregSfozNEI20vGM/q++GnAZ2FLcYleQnlvhA9vd/ze5pJ7qmgOdSuXZbUiMi13xKaey5GhW6fPt7yiyFeYJxy3nGAV8cfA+OGGYIkTGdjzEoWg+zOkmzrwmNxX+mJyKzrnDm0qu4eKMMSyqzqnDm0Kv0rcW6izN+Mc9JkHl826oAlvuIo8yMOaAsNY82j+cOxxnGGaEGMNZ/h8IJd3KCEGfS1dfdpG3mHkeVl0SoUK2oGxfKLTs+3x8mopderVrGglDA64Sg9ZTCFugzTzDomRxWxh6LWDI9ToFTNzPOfWnbLGo6c1UgNnPhMBwWPFR1YTmroMwV8DjsFmdyfxiVjODU2H0iq4bs+BzVsj0fK8nB0Dvo4/o2U5ubWzKqgN/v1OEkem2xyZoMks/oyWA/blQ3bQPXWuv1Cv64QNS/OufgCbPsQzbLe0LHelJBLtmBKvqiUrkou2YIpuTPfDEwpuWSboiRABz0pcQiQHEs6N8dwBc8f3bZ/+1P/XVVKJUg275U8SF38q3lAezwWIYb6mesQWIINqhquQDJo6fMF1dLsXtTdpxKaTbPbN+QnHE2yxkVMVQj77KvNbl+tVrdHR9pYN9LRxLP2X7pGdi/GW0j2n81983BoK9MAtopawGJ8JFqd8mO9uas3S8PpNLtQUMosOr/Uq+3juitqgsxhITOoXNUP1ZI83GQXeM4/g7ZdvT88+ks7ZQ+jDPqP98dVebWsef4DTTyr/6BrZPsPvIVT/IdVlKv/wAuc7j/sQt38h59Oq//gyHTwHz4qzf7DLpDrP3y0Gf2HXRrTf/go29dVe7f9OmGgDEqYQd/9tqUjNe3iTtnDKIOe95fHh7a6Y3peNPGsnpeuke158RZO8bxWUa6eFy9wuue1C3XzvH46rZ6XI9PB8/qoNHteu0Cu5/XRZvS8dmlMz+ujzOZ57eL4ntdHn9Hz2sUxPS9T2cjzbhqXt2Yi+bze11An3/8S7fTtU3ZNLr2KKG1Kv2II5PYsrrrRhylU+tvDel3Rt23oqWbtSUhV7A4EGkMGVRm+mEpXv1jzvpAKSjD3DxPLNEjhoUwnJRb8bxDD3gFw0vPYbr80hsvQDYIGWUMqYqxPDKKcFiZOuswrEoMk7lLEpobwKaYtxEGSa3gT9y3EYRsm+JHR1pCbE5kYikCJ4EUi8DUwvJhnVAhfA89/+W9f8pXw/QSycejuJDibzBwPgVxX4OQeGDrW1aa5r+kb/clBc8kXTMvyU738vDuQwTOUlkG+YFq25gU9JeWSbYqSAO70pMRhw3ss6dycKcCFK9CVu9ByA8AXtmg3BuOimZjCnzs8cy3tNSb1cYWus7vePOo1c4IS5ueB0GIs7uvQdqW8r756a9OKmE3hVHmzaNs3e8P3/qxG7XOH13V8aVm2zaPXaLusIYZlhNfY1n8cmpY+wmsVOChgjido/JwD4+kxv9vA04Z/B7TP++LkzumlGZ58Xu9qqJPvYIl2UgvD7gN0j7ZPcBo1LQZl+Imb6M8YEvkuzUuh2asx9HEdm5c640siQxzzhdFLm+3lkSGP/yLppZAzMzBUuk0OXkqt8wNDpsMUwdWIfiOW7Yjx1LP6YUOVbDdMNNLTC9sVOThhorBJPpghkO2CvfQZPTBDHdMBe2kz+V+GNJ779VJm8b4McWzn66WP4XsZGp1cr5dOm+dliOQ7Xq5Cgix8qHf7W+P3w0G6axAFvTJXmnBpErlhvXNs72Wbesf6WDosw7Z1IAvzEXTOGlbRfdWsDq2npkHmwM/p2LkNBxvND+qcN6ymOx6Uw0XduXJPgyrj+O4+L/DBDvz1xNcb6VqNfsP93MIJpIkW44iaQEGWsXZYrT5MUzcsYgaFTn0cFejZ0Zn66pY8QGqXpjKHUWUdg+/rx23LH4UqufM4NMk4NPua6wlOaa/mCLQKvfzAuXnk0sx0U5hNy+Kc3UNSABROC/PwT0xdLoMfleY39pnqmEMfFeY88mlNthHH1XjVkTZtlAXpxyH6sC0Wu0vDWsiOBJ2zhlXEfv0YPyH31w9cj62/8uepS+qr9t1Bld49uG8k1W+4L8W4nMUpv5eooH0aE+fZs1nqnPo3Is6zl1PaDH39/xw2zZ65GjqnDbkck4WyB9sgdUgRH6pHtoRz2pACXqi9XqYhBqmv5XJglT4uZ9jIiVMnIcdjAh2WFO4tldLn95rK1+iwVKUkei1W+Qp5y1VKnOuC1ajLPh7ZTkFLf+UxOXEhoDd14lKAlOSxGNDLCjPh0vrcp1wXfXxuSyv04bcuGh2INy3Si3w7PUnuToHhQbrvGFgUjjzJ1+rhoW7/vjN44kuSef0FqIfvIgZtoK55Mh2rwetd9Hn4lU8MEzfIcIkRH+lRDfFaxnAksVcyuLAAITwslW5BPF5abQFRLJ38kCgvjZarE3ka2Rcp+mk0ns4iBDJPZ809WDsZp+fE+KYm8nxkQ2h//XS5rHe7192RJ0rbIMnkF7+nbbV52Jo+UnBJMevkAKrhX494aQDR2w78xp2s3GdhV23p7+br/QkN3Gv92SqM1/kTIpjX+Js04Nf3d2lZV/cPEs7a//Da2N1w3CqP3mjUwOyU4zLsi1jbBzEoRW7fw+Br4nwOg9Lk9jUMvibGxzAoSU7fwjAqGt2BYh9F1xo/3iOHMWbMfXRq7wzVL6f2yEB9cWIvdO5/g9UIoyuOU8/eK4kqnToo0kjqfeYk2FvRYlCElzTr7cy2T94xNLp89I6rEvaufxzqQ/2hWddv6n3bLMl+BdPN2qPQyth9adQkwkYP9f51tTdswZhkLIa5HQVNe2viqTq9P8Xe8gYtpB/gr9XqQOM5m9Rz7v+vHqBSdXqA6aQH2LeQfoBPv5CU2KZTZf3/6tEdJTlQNsNz69pGO62/bffPquXnw6NlMoTpZnVaaGVspzVqErU86r5L/WqzPCZpdnvDiSSTnAVWiqPAKdfPGbUx751z1LOqPtKwx6jnlDOsnv2x228Pfta75J2siRxZ5g/MgmTXGVc+n5SF7aF2NsgXH0PtrE97wfwWULDtBmNzHJ7fncY4Io4uKqjiXfOf+tXm2XdDdJZJpZ49qLJjtrobKT6yBnmDatq0L55124yGr0maZOnZAyv7qVn52fCSdaoi0hu9buhVupboOp7oXJO7H5ItocZSbfoyGFk7+9tgegm2LS6XJ36eKxvO+5BFR3EW8Xr7oG/S1JvDeiDk9Luz1aOLyX96+uHpa1YFP56SWpp3Vo3W9/L9+3fvefWdkk6q77en79++evtXXo2XxJPqfPX2p3e8CvuUk2p78fLZL8z2nZK61wdd0ynJa9O6Uks0eRvxVNptvd8bgotAshDV3m7b/YumNQMtmC5ExS83xxfDemd5zRslnHUWwGtjzwTjVlGbWI97MtrGqGHR53QVYr3K07BdbhZ0yhpY0W5f0dGaZkWnrKEVHZeznoJUzsB6tvf3u9rzEZ3zhn5GddUuydAUy1M65Q2tyRD2a1G0DdSPEO/3pt7tqgdTh+pTzO3vhtW4OLpTA5zfuvE6WS/cg6wWArN9pD9VSQg45QmlweZTMQ18Z8rT0L3rOkros4RSsHbq5+cLn865Juig1xx2d3ClVYbv8oLu9/tq9dR4hTxe+ULPyRZifdM0uQFMx4rpB3j12/wA/iS4foD5DHhrq2mLKgaRPi6L1uRnnKhnMcgXTEv9zblzqixTFIgLeTh9uf4soi/3IuOUwtkLpNHF3XRcdt8elvtty6zpRz2LpbkvxtWLTEQJcTebpeo+rUedN8nl0cIAb0ul7FBuW70aC7ZUymO/thrb7WHPrvKUeGKdSxng9vftR3Z/GmSYWHe1lFe4/W2722vA1qJgnG3qM1ht2SP3x1PiiXXuPh322ifBLNUO0k+s+WvV7H/atj+328fqQT8NatGA5pzsUf447epzZQwzTLVCvX9f7x6PLrI+BxfcHqem4c6GzTDGIibqO+zqZ9WuWT49DA5nWASBPAEUHF+i69ZVwjDTRA2r7UPD7qSnxFN9cb2pv3byP2w/1+zKR7kmqnio989Xh92+bl+tP1ararNkjxI861RPuV0/HqedvuD3taMmOvtEXfW3ejlBF519ci/qi+qL5vejUb6JSs4LS6aCQfrpfdihz4boC83wsLfV9A3rYDdvHeX4GvDjKNdUT3lszCkN+xHATAE0dNHFXjpgxkC9nq3hLlzdB59nADNNbf9xqebaJ0GeyTPGKLDdOknwo9h5o/K5u4ZxviBKXt49eKsZ5Z2+wjn+j7saJF8Aj3Epz8lf6NmC9VW2hmXI+h/a6pG9xj4lDtIv/+pSs54lgO1lUU5mP+cI8cTZNT8EqvVLU3/l1tmnDWLlXx3q1XIE8TQutWs5AvSwriSnDnbKEMDS7Hq/hKmz2lSr7//hv2sM0gfpZU8d6x/lCmDvU2lONh9mCmQDdv1VuLpPy2jndXcIf1rvtWsr7O97v7AO0PN6nkvVWo6pK/3HO8fatRyTvevjqlo6Va9nmVz/evvFsfpBjjA9Druhhdf59JzTebKnGjTn5H2Numo99RB5w1jL+bUYyReGGH5oq82ucnr/QXNO3Wt0l7EPWf/H+qHZeDwLJN/U3alm/8lDyDhbgFl0UKDTZAryhesbbBX7oAr+ONTtd27Vp8STx+dxiuLv+lyST6z3mIOPyk6JQzzf9weHTUctR4jaj112+Xl4SIAjYJApwGh7f9hsjoX941hyw38SaM4Aam5X268eUvRsIeZvDyFIvolKPjer1T9cvMAwQwBr/HTYuLvhYaYg7xenAt3eMQa5AtB8Vw0gT4iRoa69dRsWlzwTFTSb3b5arfoCuRpGucK8czmqGOWa/N750FZ3ripGuaaq2PjZBMk3/e3CUYOWI1jtz7eb++YBXrXPlgKzB+2rXtrMRQShJ1PkGUsIZtXzp2MdZmIyd1Cb+igzlhDSoj7iTAVMJzTncr/Uq+3j+ljAm+0d22WYCgg3u97Ka7N95thLzql97LDRimT3rHG+YEo+1A6hPeNswXzB+7q64wesIvnCeaXt8tD1QM+5BmafukLdft2sttWd4zQ8zjZ5J3+9bvavt8vqtLrovgnsEqdIZA/yHnG+z8LtRWKYLYCnORfn5GW0XJNnsd1+27o/DiTf1H5br2oPu4yzTR/XyIlC+2jWMgXR0J+AdBQxyBVEheuGziDL9HWCa/27kPX/m38i598hzuJ0Y/tn9QWhv28/OrkEPVsAHc+33fGJfX3nqgRmDOIVXn57bFpZpLqGih9LSmYPouvpauWrCWb10DOY8tUK4iJhvb3ryPR/n39BjjzSJ6pPK5I39b7qFJyL7Y91nguFCS0HK88y3c5Xm6uzHrMms1MnWX//XH/30rDoc7oKsZys/X182popx3To2ltNW3/xlKNyTtcD+2sXlmvtq8NEM/fTUVX8Pqo1hbLAfbtdO1e+OGVzkWDrC+Prjhg6TDcdMVVQHusFx1u98OoBWKczVndKML2qk3Bry8K0ytii6VX8XO3Hdwmd65C/Tq/k3cd/18v9b83+0yvaeQ4TzewSRlXxXYLWFI8pgqqaOT1o2a0D8ZL6fwyTqJbqak/+VJfPo+9a47NcIGvnrhX0AtiO8LbuzkRsRzeTjlzGKaHHkLsEirTtoKbT2lP+1bjuzAb3Su3Ut7JeakXdn7aP+8K0VGbFShNR1+333b5e2+oapHKrS6SX3olV1Wz2dXtfLc8Pybsm8AGTAUK31vHj0gTMR3moSo8JN1uHWk/pJ1a7+75bVquVQ8WXHB5VD66Zwfrp6Y1PleHdR/XbnSuEbuMVmG95GeUxmHLbvj2subUO0k+seYlt/hC1Mroto8a2vy+CW+sgvXvNeizh9u+3795y6z2ndq/VOEuyql2o//xXZP+y57gcrQhjl5sqanEqxUua7ZtiXQ54q+MkoW8sl+AF0OswiM1ajwUZvgozTanLoCdVdoUEVTjw9H/b7x9Nfv78+zxeXi+e4+Mvgv28HqiR6fOstRoMDWpk+HasNr5/BfWxvCtWo4NvRat09qyXUib7VaYgllclZPmPfK441rhnq7u8ytxvv337r3W1ae6HH5k7vdJ0v/5++tUJqf90zPkGFqveyfRChwnNfkWX6vR2bKnS9oKs1axlpy2OxZS5iFnAIlyl2a7Ure+rw2pPoDamxnEhwVUikVyOEhmhXN76Htvtl+bOV9sgd2Bd9eah2fjKumQOrOoe+XwPU9O98fM93opWzUc/PSpjYDXr4ekjJzlr00Ekbz07EBHoJGlnCQr0VrXXAvKcNJ2yBlZUHfafRuiRKemcN7Cm4/Sxb5uPh/129B0v/gQ0LCG4Z1cdxHt+1AsIrO5z/f3rtr3zfHKD3MH91bIevs84+qxT5sCqtJc6J0nGlzx/D/HpsP64qRp4XTnXSwyyB1YGL5Z20mW7ZtpFFVyv44cgMHlayiut2Md1ui3Z9dZN9EikGA+XpJdl6dXeT2nh+6h47xDeT+uUO7Sutpa3dcMtYq6wQfYAykY7lqcXEriJqsu7JLvSGAMVug2wQaN85wi8fpcZYlDCdC9MyHHzwWxFXN9DqHJ3PGxlrLFEyHIcSGxN66PbaB5XXv1pkHeqphHzaiySugTXYlynqhzZVtcEinVUexjGZK5z0efgVmyx+sN/GvjdF0v9fY5A9Ts/c5dpF6//0rf0ezpPfFb+1TXkRL948xIGogrTUpk7q9JEjwdZxOW21O4gGv6VTFUzndxNBmOssCq0jRxbIbRHhfHELnIWpqBia0GWEdZWy/r+AF+bnOQNyphFY7Vabb++aNr99y7PFKWjkkLptYyDV8d38HbvMBK0DNcZC+MqvUaD3lTCov0nXm6/b+AnztykLfSCfGVa10P7Q7t5O7hX1kvrsJhwSq0eWB7Ad3LCwxzX8sOjOj1dsdbaqd6YEuXjkLWyzP3NcXQYdHoPDye9n+v68e1hxZxDSLGDYuZSqobguxVzEjHY/1LOvFqZXseq1dnt2LRa/U53+aqT2xlkuJbXgVV6Op1hU6f6HEKSj8sZFhXY41AqJzgcvlrHUUw/Uc9BbFSKnqGq75tNg5AeVYGeZKa+j1TC6+2gAeTe4+gDH7zaF4wPsaBlWOIOxucHrUqMhwc9NIxODloVGI4N8uo39z6TO0ZTXqUvujtgvFUheibmJzw7KM+XMfsppsu5u/IUsXotpsex87qtLF5t7nFd51/nXDOcy3dYIEjF/J0RQ23mDRGY0RIlptnAsDIbiRjnDKFn2z5+qjbYZ5nsirC8ITRtDuuPdfvu/vZTNY4HMdoJZgyhprtCr1nKncafKuS8o0kQljeEpq9t0323bLOsW9yr4nJAthBKmt1tta9Xq2bvMqD0XIF0rKsW7otbNPQ5QtS/68qSiZ/uVQiXy/PAc4d5Li+a3b+3zSjc2PxoBpk8VYyiXS6fEzMtg8bJZppXiIp4EwzSGM83O7MMh/c5pKAQnt+iz3UKcFbJmAssEp0mBWd9vNnBItF1mnBWaZ0vbN2QP3E4azN5bossngt3VsT15RZ17k7d49kZvbv18THdvPsTPM3uXiNWyz1VF5yHnt7d/Vq3+/rbxWmZ5iM6+UzzkqVC3vxkaKSfxXiq+JYzlMexIB+rUInns95UuEI2z9tydnTgYjdPitDvZ/AtZ8owk/WsVfIsaGyqnxW5yviWNJY49u6DM+vS38LRe1Z9Oms7eEGAaR1DnDIRJZbT7LbKzCfbDblpHYYvnlvVsImmoyb16JzlnLJNUqJ9D1eme/mtwa5xt8oBuQOr8tUTUsmu+uLRh/tcwVT034ZwF3LJGEyL+hSEu5RzvoBPpdte9Hkofb4pSkZutnPPPCerp5zVxSJVsR0saNBE94opcXOuXD1W14pJYTtWWoX2scRjKrtTxYRoOQOq8dERToHNjWIKuE6Up4DhQjERDg6Up8PuPjEZfOfJfRo214k/DK7jJFWM3KZJw6yu0c0ZkkPLOsj74cQe0lRND/X4gz+jalQi7zrUZ03s1ZzTedfUfQXRXk+fyruWLw6vPsMV5HOniYmqvfsAAlxBMLoKlS3YU2BowLJ411+NCZJdAZ7JW4NyXe4yyHz+HoO9TrxMxOH6o+6Ymb1xnClQ6zmOM1zdFSRirF44yjKhDyIch9MF8WwTx4K7DDSXt4p9W3XHhavx13xGVQ+TOtV32X3Z3A14wumAoPwr94BgJQ/+/fvSZS9nA1U5pwTmVYtScqkhicokvqFvDRhr/dF2NQCsAjyGAbfUCq/dPgvzcrM7tPXP3Ynv3f5Y8auuDJwSn4o3ZWE8tdrx1nd2tTZWzCnI4Vysqy7zSVlWaZbIyqZejXbsnVWeS5lNJxIL6KzSuOAPoPGwaf44TFZ5LmU2nbtjYaOrkpx1nkuZTeddfXdQIReTxepFzaa43u2bdTXeHnLWOyxoNrXNpvtU4kO7PWzgIRFnwaCs2TQvq+Wn+uWm+rga3bzhrBmUNd946z6QefdrtTpM7xigrJCa8Vn+r/WWPb2DtK7zOi7gw37FFgDSzr6wwOpzW1HA1vkuJQxKXNYQsJjJiweTLqdVg5sy63LBpMthneCmqpafn3x6v69hACJfnF5GeI3sScEk0mM2sKrEvcObu4btHUDa2b0DVp+bd4Ct8/UOBiUu3gEWM9k7mHQ5eQcPZXIO/dCJmiZRKye8VqsnMwl08GRuqhivOiZdTu84bsrY/sukz8N/WVVC//VqI0n7ncz19rjgr+9+6vqT2ZNZcs3o0zg1c72bre3uY8FBHW9U2Ao098JqU62+/4ec5l3UDoqaU/F9Xe2P3XhKvzu7xUtRcyre1VW7/CQzBBCtlzan7o3MEKIfnwoKrNboqVx91J/hncL4pZAeKaAvmskLBfY/M3mewD7HQWWzWa4Od/XT1eon07qWpxYpbB7Vjj4yvHd00Lpvj2uu181u//N2h567d5OMFjePcr5HD+rLHRRK1DlJ4KmEYPqMs8ztBXM6zDXjXNeacYiaveYdpO0+b9gO+rjv2rYiLX1wu348emjkgnEfyXpps+rmjh2bYvcRxNFqHEc/t826ar/fbtu968KNyHqtEWWq3mtYUY/CNLYCCV3cu0+cVLGWLdOmRW9x8lY+LHAO9TjV1crioF0sw+x8l6zUDfKijfUlvTZNLrgXLWsy87UqdAK/HhqtRNWq0AGreuizr9mZMl0W7f5quZvbdrnuW9seeh8vnmmaXL2gcGqDu6Gh0tN3c+kP5rIlaw9gRneAqe99ROhmTF7ATmmSy4I2aKsMy9tJ7enKvbKF+pT/U39/HqxVg8JmckkWTMeUy+Z0/pO7GdRxp3cuqfPWyUR1TL3OrM5bNxuAcZd67gTMf1qt2mq1qlfNDl7U6jrqtIJmUrtc1dXm8Phqs6/bL9Xqdl/DDyg5qsYLnEv9dr1u9qe63uxqeGmdq3isvNm0b3bbVXMnr1EL2QS62Gu05Ofj/42+WzilDecCZ1Iv74p7dri/r9tXd6OvszkqHxc2v+qny33zJZzuc3HzK79t/lO/qb4Fk34pb7b5lBlSw5hLneNqfEbm9LUfj9V6K9weU62PZvuwffyfaUJBSeH0ju4Xrzd12yxlJkLyMMmM8G1UDRe3aU1wh0NUvTwcpOW2jDdqlJEKGvtocqjfeD6I1MA8D+SgwxhkSOpgxhaadcDeD85QEJpAqqnnH3qIbqxxkGRqdafTG+QD3wap5hToTVRz+nlqNad4TKKa089Tq6GCqzj7L4Pkf0LcZpCAzYCRmuFCNOeJzQwblDlPNGbYMMzZ4i+DB17OEXEZMtTScdeeo3S64zJVFKCCdx//XS/3vzX7T6+oRz9MMqMHHFXD9XpaE1wXa1StnMWaltfady6p39JuV090lad9rsj9ecuGuM8tdN28GQXkZ4zaY77buruhZvRNAW0wndI4D6pzVf/efjxXcLq74/g3470dwxvX/j7If7ptpcv/d7SMgaiu4oEg/aa1Zvd6W90NfCtW9I+DVGQdXWq6nuM0NrwZBa3lnIZdh3ZD0raytKJP4VX6stos6/F1N1r55zReNdwde9i+fs94TiClV20P9f75dv3YFWR5aiAlu7aL6bfDLzucur78K7vzv9fKOOlUZbwnShrIUxKoK5VYZf94SmaoQSWnr246vtbuxrYd13RO6F2X6iL2qs7pvGvCrjYcVWO62pBRx6caGdqjSj6ZvnXPqOWx2i/HV1qOqjkl869ny+kEfSr/Wg6cSg7OdQw3Oze7So9VPA3uwW/GIZ4NJ6Kn8g6uD0ixl9u6hgUjOcxeYKjYgDcuqZ7LfTU8fHGohMriI4exUGNXbVu2cQoiX8JXq+3XF027//5+ODr9FC5GpfkLti/6Bjmffty2bgYe5riufUc1e5pXa3NA61L6JhpXK9bFtrf7an9gWlWlva49B3V6WrJvIffFlq3D9IZrLsQWauplkUt8aZ89jLLB8hKbdE6TJlGs11QD3r3GixpTZT+6W4VaHBA3Xxtrt9yC7agAWzYaqzctIR3rVuEybtWf8wRRUH0cRi+zBJyyBKl/N4yXYlW/MwVEMWo/V/2lqb+O1ovdH10Xir8OC7qsEGVRwzTmgSrl0NPJC+I4jqzl/OOkKp5939e7p8vlYf3cGpAkqzVmcJLCmLuYNdomMHsxDgdm3DSZD8wwyrLEfH5q692n7WgLxVXkoJhwSkero6Zumb2MSDpL/zLVxepZVLsc+xRDB6M3UaXYNuMe1sdCdtLCP622IxzNVoiWNK/ecTScn1pTFFwArQFkzq2wQWcaJ4UNffxkgsJ1s7ldblvvcTPIH0Lb6Lvn5NEeWe7g50mTtfoUbreswKGBqgwmmlRlV87P7faxbvdNvTNUiyacXnWHO/n1o6kniVAruVsZZNBV8brZfDaoMCSfZe6y1ceav0xttATBeD0EGAVDv9ZZi/M4Tuwk0XKYeKI+y0kjJ6Xsc0YTNaPBME5KLcEwE/VZT0E5aXU4AzVRtzy+jJ6DdhKsFzNTryXj+R17LCOaf6JWLJbfSaQ5kt9dnW1+Yc111kxXmWvwWr1mnHGrvU/euUt1On3HLD7MKTaftjifZAvUIsuZQq+msM8VhrcKjSYm2MNyKi9IK1ZH7zPBaZx0n4oJq9Tq/djLfV5Ot6V/mpHCDBfKNV0Hva+WlDLXW+WAKtOC1rPqH31Wtfxr5bB7LnyVcm61mCpXWyJ4C3VfJxgl4q/+sAgrBiAyTHolVqU9XTXVrivScMmWFGJIPssyxVYfa4FiaiPZ7Udf5nRXtWB82Nxanm35Po7cd5J4KiCUOkv/Yk0HtjzX6GkT1sPWJptsib8wuohbXMqZINLdst2c7eg+RnlCujL+8oOV8Sqdjq7Zq+fhT2B697PK9OuDeLF2Xi8nR1CYdTLF00/qgP0x4q64F/Vu2TaP1ASCp5ylixmqYvUpolFEJ3pYbT9Wq9X3X+TB69FhL6aiBVKMs0TXg/VcbYbQKX81yDkmrh7jYSYnRdiejaUjT+nBtvdHS9WG5CGnEYsKOnXAnTrqyV9SBN8W42LWq22ETdsBC7b1FWrPK+hmV5Bdrpm2twLvawXd0AqykzXbFlbwvavwm1bhdqtCbv2E2POZstnjBmyDvvMYNZCJ3RjmINhdC5w9Bf+epye3lukB7dqCCC/5R/vK51f49Cxh46ACU6C4tXwiMB5UYQmFt9aylC8ztlrOqTxrOaZj2OOcyrOWx3HvJWrSUnrWdni8Oz4TZMQQdSLpvZ/m46paOlSNZfCs++5Yhq26Pg2/hiQqk/hmsKr643K8/RSX31wu51I/48U34EI2WPSLal99rAY3kiHlD9IYK/nXk/7//vK/P3zprus6LvH/8oNYxIvymLpfR/3lnydf1G1hdvn/1f/2q7zFoUuhkvz3zQ9P/nnzJI0WSZ79619P/nnKIX+Qf5DJouO/oidZuSjjQksWacnE8V8CSya0ZPHxXzGWLNaSJcd/JViyREuWHv+VPhHRQohUS5ZqybLjv7IncbG4iYSWLNOS5cd/5U+SaFGWpZYs15IVx38VTxKxKNJIS1ZoyY5G+WeJNaHUH+8N1YYI2CGiWhHplogE1Y5It0UUUy2JdGtE3VOPbtBOoBskIi0S6SaJSJtEulEi0iqRbpaItEukGyYqSY26aURngAjt+0K3jZCDBO/+YJgIqnKhG0fE1AMSunFEQj0godtGpNQDErptREZq1G0jOgtE8ZO0WJQgoW4b0VkgQge00I0jSOMI3TjxDfV8Yt02cUQ9n1g3TSyo5xMDHxZTGmPdNHFCPZ9YN03cGSBKn2RHZ5zFekrdNnFngSh7kiWLQoDm6MaJpXFy1Nfq1okLsj26ceKSfOa6cZIb6pknunGSiHrmiW6chBw3iW6cpDNBVGAPKAFzjLROiabUzZN0NhA3aErdPElnA4G6jEQ3T5KTDdKtkxTUQ0906yQl+dB166Q31ENPdeukETm/6tZJBdXRU906aUx29FS3TtqZQAjsmadgESCtgy4qUt06KT14Ut06aWcDgTqsVDdP2hlBpGhK3T4p6dpS3T7ZDdkxM91AWUR29ky3UCbILpzpJso6O4gMa1CmmyhLqAZluoWylFyAgYVaRnXhTLdPllNdONPNk5G+LdOtk3U2EKi7zHTz5DdkH8518+SdDUSBlZnr5slJ95br1snJZUGuGycnlwW5bpycXBbkunFyclmQg3W0HDzo2jfXrZN3NojRhWWumyfvbBBHT9J0IXIgUzdP0dkgFogvKnTrFJ0J4hgbEoVunaKzQYx6g0I3TyHfb1BvUOj2KcjBU+j2KcjBU+j2KcjBU+j2KcjBU4A3HXLwFLp1Cmkd1GcUunVKaR10mJW6eUpy8il165SCekClbpwyph5QqdumTKgHVOq2KcnXnVK3TZmRs1mpG6fsTBCjPqPUrVPKwYO/YoJXUXLmKeHLKLmqVj8Nk5LravXTMCm5slY/DZOSa2v10zApubpWPw2TdtZI8BfYG/BiekO6OfXTMGlOPy3wcnpT0E8LvJ7elPTTAuYywIMRPehsguKeCPIDiQkSnPlAhCBJQYK++UaQIkSky4sgRohIpxdBkBCRbi+CKCEiHV8EYUJEur4I4gRJDRJ0HokAUYgkN0gSNC1gCpEkB0mKp4XIR5oMdcARAAuRoIcYQAuRJAi4GQBciCRDIKgTsJikCLgZAGCIBPmWFAHEEEmQQJgBQIZIsgTKDMBkEick6IwVAdQQxeScFQHYEMXkrBXFENOR81YEgEMUkzNXBJBDFNOoDjCHSJKFBJ2TIkAdIskWcD8DsEMk6UKCTmARIA9RTEM7wB6ihJ7DAH2IEnoOA/whSug5DBCIKKEHWALBKj3AAIOIJGlIb7DpDkCIKKGnMEAhIoUhInQkABARSd6QCuzFJwIsIpLIIY3xtMBgkjqk6PI6AkQiopFEBJhElNIjDFCJKKVHGMASUUqPsBSycAMMBxaT+CFF3xsigCYiCSBS3NcDOBFJBIF3GkAnIhpPRIBPRJJCpLhLBIQikhyC6DSAUUSSRBCdBlCKSLKIFPdJgFNENKiIAKmIaFQRZXAHg154AFoR0bgiArwiooFFBIhFlJE4NgLIIpJgAu8HgFlEOT3CALSIFLXAnQfgFpHEE0Q/AOgikoSC6AeAXkQSUqT4JAIARiQ5RYa/BuRw24leeQCIEUlUkUWdIUZPAZgsJxltBDBGJGlFhq+sAcmIJK/IUAQaAZYRSWKR4d4W0IxIMosMd0uAZ0QSW2S4WwJII1JMA3cggGpEEl5k+EAHYCOS/CLDOwNgG5FEGDneGQDeiCTEyPE3IgA4IokxctxuAHFEkmTkuN0A5YgkzMhxuwHQESnSgdsNsI5IIo0ctxvAHZGkGjluN0A8Isk1ctxugHlEkmzkuN0A9Ygk2yhwuwHuEUm8UeB2A+hD3JDxEAKgDyH5BjrgBUAfQqEP8SSNF0UCkoINX8k3ivhJKhZpAbebwZ6vBBxF8iTNFmUCtocB/BAScBQpnhbs/ErCUWSY5xWAfgiJOAq0MwiAP4RkHAXaGQTgH0LxD0IDMJqkHAXacQQgIEJijhLtOAIgECExR4lv/QMEIiTmKNGZTQAEIiTnKNGZTQAGImgGIgADERJ0lPj+OoAgQpKOEvUNAlAQIVFHmaGDAmAQIVFHiXcHGFghUUeJdwcYWiFRR4mbeBRcIciBCcMrJOqIbvDuAEMshAqAwfsDDLOQuCO6waNBYKiFBB7RDToFCBhuoeItbnA7w5ALFXNxgxsaRl1I6BHdoLOAAERESOoR3eCmBkhESO4R3aB7lAJAESHJR3SDGxtgESHZR4SHJQkARoQKxeiCeZCRB9CIUOEYRDwPgCNCRWREuAUBHREqKIOIhAF8REgGEkW4BQEgETQgEQCQiETFNWXYpAQIiZAYJOrCSBDzAUYiJAiJuv1o5CEDSiJUoEaE2xpwEqFiNQRua0BKREK+dwtASoTEIbjDAKRESBoSCfRtRwBUIiQOiQQ+KQBWIiQPiQSKLgWAJUICEXwjVABYIlIVlpagKgAuESqGA49kEACYiJREXAIAEyGpCP6IATARkopEAg3QEACZCBXMIfCeCZiJSMmdGgGQiUiV6fDJCUATQUMTAaCJyEgsKQAzESqsQ6ARIAJAE5Gp2Bs0tEMAaiIkGYli3A0CbCIytcGGu0EAToSkI1GMu0GATkRmiDAElstoywF0IiQfiWIU6wsAT4QkJFGML4sBPhEq5CPG16QAoAhJSSJ8j1sAhCLowA8BCIrIle3wjgkQisiV7conSbooU+DkAUMRkpNECd6FAEQREpRECd6FAEUREpVECfr+AzCKyFWQKB5OCqwnYUmE7+AIQFKEpCVRkmIiAEkRRWRYJwCUIiQuiRLcXwGWIiQviRLcXwGYIiQwiZICexYApohCWa/EJQPrSWISoSRQAJoiJDGJUnzVC3CKkMgkwgGfADxFSGYS4YRPAKAiShVvha+ZAFERdNSIAEBFlPTLAuApQjITau4HQEWUiWHuB0RFlKlh7gdIRUhsQsz9AKmIMjfM/YCpiFIZD5/7AVQRdDSJAEwlvrmhPXIMqEp8E9EeOQZcJb4RtEeOAVmJb1TUKfp2EwO0Et+QmwUxICvxTUo72RiglfgmI71QDNBKfEO7zRiglfimoP1xDNhKfFPSviIGcCWObkhfEQO4EkuAEuF7QjGgK3FETnoxgCtxpEyHTnoxoCuxOqeCbwbEAK/EkqFE+G5ADABLHJELlhjwlVgylChDfUUMAEssIUqEU/4YEJaYPrgSA8ASC/p0BOArsTAsNmMAWGJhWGzGALHEwrDYjAFiiRViwfcwYoBYYkG+4cUAsMQKsBBjFACWWAEWfCEUA8ASC9PAA4AlVoAF33aJ4dEWBVjwfZcYHm9RgAVdNsXwhIviK/iyKR6dcolphwUPuii8gjsseNalpyv4c4PHXRRdwZdYMTzxougKvsSK4aEXRVfQJVYMz73EJrcJ8EqcGNwmwCuxwiv4rlkM8EpMn4GJAVyJFVzJcnQuBXAlVnAlQxFdDOBKnCi3iftYgFdiOhAlBnglVnglx4cewCuxwit5hIHpGOCVWOEV6lkA46U3hmcB+Eqs+Aq+1xcDvhKntPUAXYnVKRmieYCvxBKiRPgmYgwIS0yHpMSAr8SpyXECvhKnynrohlQMCEusCEuOL/QAYYklRolyDFbGALHE6uAMvj8ZA8gSK8iSo7AyBpAlVpAlL7ExDRhLrBhLt0OJFQyspxgLvkUZA8YSZ7T1AGGJM5P1AGOJM5P1AGWJM5P1AGWJFWUp0MD3GFCWWFEW3NQAssQKshCDGkCWODdYD1CWODdZD1CWWFGWAh97gLLEOW09wFji3GQ9wFji3GQ9AFni3GQ9QFni3GQ9QFniwmA9QFlidfQGfZGNAWSJFWQhximALHFhmvcAZIkVZMG7BYAssYIsRLcAkCVWkKXAF3uAssQFGWgUA8YSK8ZCdAvAWOLC4DgBYokVYiG6EEAscWkaegCyxKVh6AHKEivKUuDLXkBZ4pJ+TQeMJVaMpcAXWYCxxKWyHT6HAMgS95AFRT0xgCxxabIegCxxqYYe/t4LMEuiMAseBpEAzJIozFKiPTkBmCVRmAUPhEgAZknoszsJgCyJOruDr3ASgFkShVlKdJmVAMyS0Md3EkBZEkVZ8GiMBGCWRGGWEh0iCcAsiSQp6BnEBECWREGWEj1OmgDKkijKUqI9OQGUJaEpSwIoS6IoC/EkAGVJFGUhngSgLIkEKfiTAIwlkSCFfBLAdoqydOEmWGJgO0VZ8HiTBFCWhKYsCaAsiaD3YhOAWRKFWfDRnwDMkijMQjxigFkShVnwCTIBmCVRmAUPp0kAZklozJIAzJKYMEsCMEuiMAvVPGA8SVIEHqiTAMySSJIi8ECdBGCWJCZPzyUAsiQKsqCTaQIgS6IgCz6ZJgCyJAqyEM8NUJZEkhSBRxYlALMk9PmeBECWRHIUcROjHRlAliQ2GQ9AlkRBFsKxAMqSxMp4+L1P8IaRhDYevGNEchSBR0Il8J6RRF2UgLtYeNeIJCniBgVOyei6EWU93AvBG0f6K0fwcQovHelvHcGndHjviGQpAr/WKIF3j0iWIvBIqATePyJZisAjoRIAWhLJUgQeCZUA0JLQp34SgFkSyVIEHjSVANCSSJYiInQXKQGgJVE3kuA36iQAtCTqUpIINzZALUmq7IcbG6CWRF1NgodCJQC1JCl5miQBoCVRoAWNCksAaEkkSxHUPTfAeJKlCIH3IQBaEnVPCX6bSwJIS6KuKhEozk4AaUkydaEMep42AaQlUdEsxCIZsJYkU4f7cZcBWEuS0ff+ANKSZIWhdwLSkqj7S0SO+nBAWpKcdp4AtCTqDhOBX6gEQEuSK+vhdyoB0pJImCLw2z8SQFqSnHzdSwBnSVQ0Cx5xmgDSkkiYImK8JwPSktBnghLAWRKJUgQeO5UAzpJIlCLw2KkEcJakoG0HMEtSRIbxAThLIlGKwG85SQBnSQr6VQ9QlkSSFIHfiZIAzJJIkkINUoBZkkLZDh93ALMkkqUIPCorAaAlkSwFPbWRAMySSJSCn9pIAGZJJEnBT20kgLIkJX0zGmAsSaksV+DlAsuVatThQxRAlkSSFIHvhyYAsySSpIgE3fhOAGZJ1IUoCUpOEoBZklLdxoUGySQAsySSpIgEDXxJAGZJJEkR+CULCcAsqSQp+EGaFFCWVIIUge9bpoCypBKkCHzfMgWUJZUoRSSoe0sBZ0lvlAHRjcsUcJZUohSRopNeCjhLKmGKSCPszjcAWlLJUkSKX+YGQEt6oy5UQy+TA5wllTBFpKiDSwFpSSVMEWmKFQxASypZSvdRRqxgAFpSSVNEmqMFA+tJmCJS3HqAtKQSpogUHaspIC2pxCkiw60HWEsqcYrIUOsB1JJKmiIy3HoAtaSSpogMHaopQC2p5Ckiw80HYEsqgYrI0KGaAtqSSqAiMtx+gLakEqiIDB9+gLakQl2PhxsQ0JZUAhWR4QYEtCWVSEXgO+Ap4C2pRCqiA6iIMwK8JZVIhXi/TwFvSRVvyXFzA96SKt6S4+YGvCWVUEXkuLkBcUlj8oxlCoBLKpmKyPGeAYBLGscGjwiAS6qAC+ERAXBJ45T2iIC4pIq4EB4REJc0zmmPCIBLGhcGjwiAS6qAC+4RAW9JkxuDRwTEJVXEBfeIALikCrgQHhEAl1QBF8IjAuCSKuCCOznAW1LFWwgnB3hLqngL4eQAb0kVbyGcHOAtqeIthHcBvCVVvIVwGPDO1563oC+TKbz3VUIVgR8KT+Hdr4q44FEXKbz/VRGXHG8gvAJW3bWCLcPT0R2w8pAzugxP4S2wkqjgy/AU3gObkjd3pPAiWHUTLL4MT+FdsKl65cM7MsAtqcIt+DI8BbglVbgFX4anALekCrfgy/AU4JZU4RZ8GZ4C3JIq3IIvw1OAW9JMvTrgHhzgllQSFWIZDmhLmqk3B+LKX2BAxVuIZTjgLaniLcQyHPCWNL8xrM0AcUkVcSEWOoC4pIq4EAsdQFxSRVyIhQ4gLmluWrsA5pLmqWE5AphLmhu2G1LAXFJ1mSyxHAHUJVXUhViOAOqSKupCLEcAdUnVbSzocgRQl1RRF/w2ixRQl1RRlwIf2oC6pBKtCDxYLAXcJaUvmE0BdUlVcAuKflMAXVIFXXCnDJhLqpgLHh6VAuaSSrAi8KCZFFCXtKDv0gbQJZVgRRT4cALUJS3Vjc34xAe4S6q4Cx4qkgLukpYkMUsBdUkVdcFjP1JAXVJFXfDYjxRQl7QkgyNSwFxSxVzw6zJSwFxSxVzwMJEUMJdUMRc8nCMFzCWTXEWUaBfKAHTJVGgLHlWSAeiSKehSohNUBqBLpqBLiXaiDECXTEGXEl1qZQC6ZAq64PdmZAC6ZAq6lOgSIwPUJVPUpSTukQfXpN+om7hRc2cAu2Q35OjLAHTJJFiJ8Q35DFCXTIKVGN/fzgB1ySRZifGbMzKAXTJJVmJ8azkD2CVT2AX3yRnALpkKcME3lzOAXTKJVmJ8czkD3CWTaCXGr9nIAHfJImU/1GdkgLtkEq3E+OZyBrhLJsj9hgxQl0yosE68EwHqktFfwskAc8kUcyGGKmAumWIuxFAFzCWTWCXGN8MzwFwyoY5f4t0TMJdMYpUY3wzPAHPJJFaJ8c3wDDCXTKir8NE4qQwwlyxWIUro+jADzCWLlf3Q9WEGqEumqAu+4ZgB6pJJsBLj2+EZoC6ZBCsxvh2eAeqSxSrADO9zALtkkqzE+L51BrBLJtFKjO9bZ4C7ZBKtxPi+dQa4Sxar8EDc3AC8ZIn6ngHuYAB4yRLDbm0GyEuWGHZrM0BeMglXYoFPaoC8ZJKuxPjdHBlAL1miLEhoBhZMlAXxvgHQSybpSoyfVswAeskkXYnxneAMoJdM0pUY397NAHrJ1JUtMfq+kwH0kin0glOEDKCXTNKVGN+zzQB6ySRdiWPcMQL0kkm+EuN7qxmAL5kKdkFBWwbgSyYBSxzjXQPQlyxVBsS7BuAvWaoMiHdnwF8yiVhiHKlk8Hs8ErHEOFLJ4Cd5JGKJE/SFNYNf5cnUl0XQF9YMfphHIpY4wa0Nv80jEUuc4G4Dfp9HIhaqh46+0ZMZeij8Tk+WGzod/FaPAjB4P4Kf68lKQz8C/CXLbwz9CPCXLI8M/QjwlywXhn4E+EuWx4Z+BPhLlieGfgT4SyYRC9WPAH/JJGKJkwy1NuAvmUQsMX7/fQb4S6a+54PfFJ8B/pLl9FsEoC+Z+qYPflV8BvhLpg4XpfiKAPCXTH3aB7/jJAP8Jeu/7oN7fcBfMpq/ZIC/ZJKxxCm+eAAAJlOHi4iXXEBgMnWFCx5enAECk0nIEuMXrWSAwGTqkz8pPrABg8nUV3/wCzgywGAy+gqXDBCYrD9dhD8LQGCyUlmP+MQXsF5peocHDCZTDIZ4PwEMJitN7hNQmEx9DQg7PpEBBpOpzwGlBbYFkgEGk5XKe6LGAwgmv1HGw7/nBRBM3p8uIr6OBj56pk4X4XfU5ADB5DfqFQJ1+DlAMLk6X4QfD8kBgsklZYnxm0BygGDym4xereYAweSSssQZ6l1ygGByhWDwLcgcIJicRjA5QDC5QjAZGoOfAwSTKwSD31ORAwSTKwSD31ORAwSTKwSDO4wcIJhcUpYYvxchBwgmVwgGv048BwgmVwgGv088BwgmVwgGv+wgBwgmVwgGv1E8Bwgmp08Z5QDA5OqUEdEvAILJBek8cwBgciEM/QIgmFxSlhi/Aj0HCCaXlCXG70XIAYLJFYLB7y/IAYLJ6U8T5wDA5ArAdMdwbo5zA0wMbKcADB5CkgMAkysAg++O5wDA5PQhoxzgl1zhF/x1NQf4JY9N1gP4JVf4JcfdIcAvucIv+M3tOcAvucIv+GZXDvBLrvALfnd7DvBLrvALvtmVA/ySK/xS4D0O4Jecvio3B/AlV/AF38HKAXzJJV+J8R2sHMCXXPKVGD/snAP4kpvgSw7gS26CLzmAL7mCL/iGVw7gS05f55ID9JIr9IJzxxygl1yhl4JQDKyXGPBnDtBLrqJecEiZA/SSp8p+eMcH6CWnr3PJAXjJFXjBt+hyAF5yBV6IZwHAS56mhmcByEuuThlRzwLYT5EXfPsvB+Qlp08Z5YC75Cn5zZocUJdcURd8UzEH1CVX1AXfVMwBdckz2naAueSKueD7jzlgLrliLoSbBcwll1gFPxmZA+SSS6oS4xf85wC55Aq54Df85wC55PTnhnJAXHL1uSEsBCKHX0hWvAU/p57DjyTTHxzK4VeSFW3BN0tz+KVkRVvwU985/Fqyoi34uegcfjFZApUE3yzN4VeTJVBJ8B3QfPTl5Fwmxrsx/HiyBCrJDfoWl8PvJ9O0JQe0JZdAJblBA2NyQFtyCVSSG3zlBGhLLoFKcoPPCoC25BKoJPjh2hzQllwilQQ/9JUD3pIXyn4o4csBb8klUknwTc0c8JacvswlB7QlLwrTUwbWk0CFfMrAfuWN4SkD2pKXkeEpA96Sl8LwlAFvycvY8JQBb8klUknwjdgc8Jac/uxyDmhLrq7MJd4CAG3JFW3BwWgOeEsukUoSoaGTOeAtuWQq+DdicsBbColU8ImhALilkEQlwXeZC4BbCklUEnyXuQC4pbgxLDkLgFuKGzXxod2zALil6K9zQWfJAuCW4kaNPvyL6gC3FDfk6CsAbClulPXwT5YD2FLQsKUAsKWQPCXBD4kXALYUkbIeOkMVALYU/VeZ0eFUANhS9J9lRp1WAWBLIXlKgu+KFwC2FJKnJPinzAsAWwrJUxL8dusCwJZC8pQE3xUvAGwp6O8zFwC1FOr7zPgGegFgS6E+0Iyf5S4AbCnUF5oJkwDcUqhPNAu8ZwDcUojY8OAAbimEsh/ejQBuKYTJfgC3FELZD10VFQC4FJKpJPh57gIAl0LQ9gO4pVAfa8Y35guAWwr1tWZ8Y74AwKWQTCXBz10XALgUkqkk+F57AYBLIZlKgh96LgBwKSRTSfC99gIAl0IylQQ/x1wA4FKoDzfjn4woAHApYtp7AtxSqC83x+ghqgLglkIylSRBg98LAFwKyVQS/OPzBQAuhWQq+OfJCsBbColUEvxL9QXgLYVEKkmCdwzAW4qE3OgrAG0pJFBJ8B38AtCWQiKVBN/BLwBvKSRSSfAvwBeAtxQSqST4nm4BeEuR0JMfoC1Fagi1LgBtKSRQSRL02qoC0JYiVdbDrhEsAG4p+jgXNJihALilkEQlwTeLC4BbCvr23ALAlkLylATfVy4AbCkkT0nw04AFgC2Fuj0XvZa7ALSlUHe6oNdyFwC3FJKoJPgmdAFwS5GR7+wFgC1FRn5mowCwpVCwBV+sFwC2FOqAER4LXQDYUqj7XPBL+QtAW4osM5gD0JZC3Z2LmwPAlkJdnYubA9CWQiKVBN+MLwBvKej7XApAWwqJVBJ8G64AvKWQSCVJ8ZcAwFsKiVSS7tAn4o4BbynUzbn4BTsF4C0FfXNuAWhLoWgL/r2IAtCWgr7PpQCspaC/8VwA0lKoc0XoCZkCoJZCoRZ8b70AqKVQqAXfpy4AaikKknEWALQUCrRk6D2GBQAthQItmUCHHQAthQItWYwnBqZToCVDz2UWALQUkqYkGUq+C4BaCoVa8N3kAqCWgj5aVADQUijQQjw4AFoKBVqIBwdAS6FAC/HgAGgpFGghHhwALYUCLcSDA6ClKJX98Fd1gFqKUtkP+6BCAUhLUSrz4f0ekJaipN8VAGcpJEshLaKbr7y5oS1SAtJSKtKCW6QEpKVUpAW3SAlIS3kT0xYpAWkpbxLaIiUgLeVNSlqkBKClVKAFj14oAWgpadBSAtBSKtBCCS5A4tIgGFhPkRY8IqEEpKWMyPVKCThLqTgLfuC0BJyllCgFnRZKQFlKRVnw6bEElKVUlAU/yFoCylIqykJ0TUBZSkVZiK4JKEspUUqCf3S+BJylpENaSkBZSkVZiGcMKEup7nLBF3oloCwl/QXoEjCWUhjWKyVgLKViLMQzBoylVIyFeMaAsZSKseDstASMpVQ3ueDn9UvAWErFWLDv0JSAsZSCth0gLGVsmPRKQFjK2DDplYCwlIqw4HE1JSAsZUyepy0BXyklQkH3nEtAV0pFV/C7LEpAV0pFV/CLl0tAV0qJUJLuIvxxeGYJ+Eqp+EpxgywhS4BXSoVXCvTofQnwSqnwSoH3H4BXSolQEjz4pQR8paQ/TlQCulIqulKgYZ8loCulRCjUQwZ8pVR8hXjIgK+U9LefS0BXSkVXCFcB6EqZGIwH4EqZmIwH8EqZKuOhQKgEeKWkr8wtAVwpFVwh7AHoSikBCmUPQFdKRVcIewC6UkqEgtsD0JWypyu4PQBdKRVdwe0B4EqZFgZ7ALpSpsp4uL8CeKXMyFf0EsCVMlPjDv3ARgnwSpkp46FbsiUALGWmRh66YVECwFJKhpKUaDhiCQBLKRlKUmJHd0rAV0rFV/BYnRLwlZK+L7cEeKXMCkNvA3ylVHylxFdYgK+UEqIQrQOApVSABT8MUALAUirAgsfqlACwlAqw4FE1JQAsJX1hbgnwSqnCWUo0BKAEgKVUgIV4yACwlCqchXhuwHoqmoV6bsB6ubIeinlKAFlK+sbcEiCWUiEWonUAsZQqmgW/YKEEkKVUkIUY1ACylOrsEB5gVALIUhYkHSsBYikLQwhgCRBLqRAL1TxgPYVYqOYB6ynEgodElQCylJKjpHhIVAkgS6nODuGXQpQAspSSo6T4pRAlgCwlfX9LCRBLWZpmPYBYSoVYCD8EEEupEAs+ngBiKRViIcYTQCylQiz4LRYlgCwl/QHoEiCW6ObGEIDb/6olN0x9/a9ackFPUf2vWnLD9Nf/qiVP6Km1/1VLLschfrlH/6uWnAym7n/TEstZEI/S6n/VkpPErP9NS1zS3bX/dZhccRd0OdX/qKWO6JVa/6uW3LDh0P+qJVcXg6BooP9VS07Oif1vWmJlTnSK6X/Vkktz4neq9L9qycllTf+bltgQatb/qiVXG+7YZmn/4zC1MNxO0P+qJZceFg+H7H/VkpOvhf1vWuLY1E4BzamYDL6D3P+qJU8Nj0VAe6rLXsjHAu0p2UuKxy/2v2rJDQNUQHuqABiyndCgCtAQ7YyhPftDR0Q7Y2hPiWFS/A6c/lctOTlr9r9pidWJdzT8sv9VSy4D6NHoj/5HLbUcn3ikZP+rltwwPmNoTYlkUjywsv9VS07On/1vw8TqO0d4AGT/q5acfO3vf9MSK2MSM1YCjZkYjJlAY6qoGDwQsv9VS04uYvvftMTKloRrTqAtFb1BdxX6H7XUypiEI0+gMdUlvPhB8f7XYXKJaVI8MLP/VUtuMGcKzalug8HDJ/pfteTSnHjYZ/+rllwaFL8Oqf9VSy4Nil+I1P+qJZcmxYM/+1+15HJ44jGd/a9acmlTPKqz/1VLbhigKbRoHzeD8vv+Vy25ut0VDXzof9WSyyGKR432v2rJlU2JkZFBm6qvT6MXf/Y/aqmVSYmRkUGTZplpzZpBkyrQg4eP9r9qyaVJ8ajQ/lctuTQpHhfa/zpMrgJq8MjQ/lctuRymeGxo/6uW3LAoyqFJJdhJ8VDS/lctuTRpjF6P3P+qJZc2xWNP+1+15NKmePRp/6uWXF0/EuGdPYc2Vdf34sSh/1VLrr4XSHSwHNpUYSA8GLb/VUtucL0FtGhhdL0FtKn6fBJ+xVD/q5bcaNMC2lQBoYQYSQW0qbpQJiZmsALaVB1xwiN0+1+15IaVbgEtqsAQHqTb/zpMrtAQHqbb/6olj0xPvYQ2VZfLUE+9hDZVgAiP7e1/1ZLL6RSP7u1/1ZKnprVxCW2qLvrFw4H7X7XkndXQrZf+Ny2xfBulXulLaFNFi/Bg4/7XQfLoRtkUXaxFkBdFkgil+MVQ/a9acul48Wjf/lctuTQpHsTb/6ollybFr4fqf9WSy2GKB9z2v2rJpUnxgND+Vy25HKYp3r8iSIwiRYzwG5r6X7Xk0qj4XUr9r8PkEguleFRm/6uWXFoVj4rsf9WSS6vicZH9r1pyaVX8Up7+Vy25tGpGWBVio0hho4ywKsRGUWS4i63/VUsuP0eBfuai/1FLTX7Grv9NSyxNit/80/86TK6uBcbv/ul/1ZJLk+IhmP2vWnJlUqJ/QXAUCWVSon9BcBQJZVKif0FwFAkDaIggOIrUFTV4IF3/q5ZcjlM8jK3/VUsuxyl+tU7/q5ZcGhW/XKf/dZhc3RaMX2DQ/6oll0bFv3Td/6oll0bNiS4D2VGk2BEeDtT/qiWXRsVDd/pfteRynOJxDP2vWnJlVaLLQHwUKXyE33TT/6oll1bF77rpf9WSS6vit930vw6TS0h0g3dfCJAiBZDwoJ/+Vy25tCl+503/q5Zc2rRAY137X7Xk0qZ4hEX/q5Zc2hT/IEP/q5Zc2hS/76X/VUuubEp0AciRIsWR8BtU+l+15NKm+G0n/a/D5Ioj4TEU/a9acmlV/BqT/lctubQqft9I/6uWXFoVj2Lof9WSS6vicQz9r1pyaVX8vHj/q5ZcWhUPDeh/1ZJLq+IXf/S/asnlORB8Z77/VUsu70zBd7r7X4fJJS3Crwnof9RSy0/k4Tvj/a9achkai++N979qyWVoM7473v+qJVcXcKD72P2vWnIZ7IVvOPe/asllrB6xtxpBlhRJWpThn07of9WSK6MSXQaypEhdhENs9UWQJUW5+nQQ0WUgS4py9eFDostAlhTlKuCZ6ASQJkW5ClgnOgGkSZHkRRmxsxFBmhTlKoSPsCqkSVGuIjAJq0KaFOXqLZWwKqRJUX9ki7AqpElRrq43IqwKaVKkPghFgPwI0qRIEqOMgO0R5EmRJEYZAdsjyJMiSYwyArZHkCdFkhhlBGyPIE+KJDHKCNgeQZ4USWKUEbA9gjwpksQoIwh3BHlSJJlRRhDuCBKlSDKjjGDWESRKkWRGGQGhI0iUIsmMMgJCR5AoRZIZZQSEjiBRiiQzyggIHUGiFElmlBEQOoJEKZLMKCO4cgSJUiSZUUaA4ggSpUgRJQIUR5ApRZIaZQSbjSBTiiQ1ymLCqpApCYmNMvwGgv5XLbm0KkE4BYRKQmKjjICWAkIlIbFRRkBLAaGSkNgoI7CigFBJmL7h3f+qJZdWJSikgFBJ0Oe++t+0xNKm+LcX+1+15NKm+NcX+1+HySNlU7zHCIiURKRsivcYAZGSiOgdGgGBklCHwAiqKCBQEhIZZQRVFBAoCYmMMoIqCgiUhERGGUEVBQRKQn3cG/8ccv+rllzaFP+8cP+rllzalNgbFZApCUmNMvwbw/2vWnJ6h0ZAoiTUwTCqe0GiJISyKe6/BCRKQtCRZQLyJCGRETkwIFASQlmU6OkQKAmJjIg9XQF5khDKoMS4gDxJSGKUEahVQJ4kJDHKCNQqIE8Ssfr6IgosBcRJQgKjjACzAuIkIYFRRoBZAXGSUIfGCBwqIE4SMXl4pf9NSyx33CKcPQkIk4T6/jf1WKBFJS3K8M/H9r9qyZVFic4IWZJIyFj6/jctcWToihAlCQmLIvyC//5XLXlseogQJQn1MXDiIUKSJCQrygj+LCBJEvRRsv43LXFuMhDkSEJ9EpwSDs2ZGM0JMZJIDeaEEEmkJnNChiTUZ8EJ3RAhif5YWfokybpTmk+yrHiSlIvjGg/mhIZN1UAlPBikSYK+w6f/TUusTlajZ137X7Xk0rIE+heQJQl12Aw/HNv/qiVXcdo4YRGQJQmJizJiY0FAmCQUTCI2FgSESULBJGJjQUCYJBRMwg+S979qyaVNiZ0CAWGSUIfPiFMDAsIkoWASsbEgIEwSCiYRGwsCwiSR0cc/+x+11HK84pft978Ok6uDaER8vIAsSfQsCfVLkCQJRZKILQ4BSZIwXffT/6olT0xDCZIkQV/50/+mJc4MjxxiJKEwEnYcvP9NS6ysiSNZASGSyA3neftfh8kVRCK2iQSESMIQkiQgQhIFeRNC/5uW2GhMCJCEugSIeOCQHwl1CxD1UCA/EuoeIPw4cv+rllyak9g7E5AfCUM8koD0SBQquBc/XyIgPRKKHhH7cgLSI6HoEd4RITsS6rAasdcqIDsSih0R23gCsiOh2BGxjScgOxL0Bcz9b1pi6W6JPT8ByZGQbCjK8TNdApIjIdkQ8Qmw/lctufS3xI6igOQovqHXRzHkRrH69hX+sbX+Vy25+ngZHl8WQ24UK25EbG7GkBvFN/QbaQypUSy5EGWiGFKj+CYzNjSDydW3QFDPH0NsFN8og6KrzBhSo1hyIfohQnsqakRs+caQGsX0tUH9b1piYXqIkBrFkguRDxFSo1hyIeqxQGgUK2hE7FXHEBrFEX0WMYbIKJZQiAiHiSExiiPDVbH9r1pyw2Wx/a/D5IoYEZvsMSRGsYEYxZAYxZIJUe2EwChWZ9eodkJgFPdn14h2QmQUK2RERAfEEBnF9Gey+t+0xHTwZwx5Uax4ERF3EENeFCtehJ9u7n8dJpdEKEpiLPgzhrgolkQIv3qz/1FLLd0tevlm/6OWWnpbIgIihrQoljwoSvFlYgxpUSyJUIQHucYQF8UKF6XoFwH6X7Xk0p5ENEYMeVEc0wuiGNKiWPIg0mlBWhQnNybzQ14UK15EmB/yoljxIsL8EBfFChcR5oe0KE6M9oS4KE5M9oS0KE6M9oS8KFa8qHNEWOHQnIkaoMQyAfKimL7duf9tmDi9MSiBuCiWRCgjAnFiyIti+oNa/W9a4tikBFpTISIixieGiCg2IKIYIqJYQiBSCbSlZED5/2vsW5dbx3Gt36V/d52yxJt03uB7hqmpLsdRsjXbsTO+9O7MqXn3jxeBAiAupf901NsmTPECAgsLIKAPGY0QGQerzi6fiS+PO+eVhodMqUcE/Amj4SGTAaAAiExGw0MmA0ABUJOMhodMBoB616prsXwovp2hXNdWExocMr5ERF3723o6y+XmyRFufVtPpy/T2fayjIaGjN+ZTo0MGb83nRoYMmF3OjUwZEKZTnC8aWjIFGgIhP2MhoZM2JtOjQyZsDedGhgyYW86NTJkwt50amTIlHrQcBD1dOKa0Mtn4stpxtpouNG4kMnID6D5Gw0LmQz9DKDXGhcyGfsZgMOkgSGToZ8AeHpGA0MmYz8B8PSMRoZMxn4C4OkZjQyZjP0EwNMzGhkyQ9mdQO1rZMhk9KdvF+JcPhVfT5MWAK3PaGzIZPQnAFqf0diQyfhPALQ+o9Ehk/GfAGh9RqNDJuM/AdD6jEaHTLkMPbQL4RiNDplyHfqhXVLCaHzIZAQoANKg0fiQKXWNACJrND5kxjKrbfDRaHzIjGVWwQLW+JDdwYesxofsAeN9VqND9lBmtI3IWo0O2QMsRLx8Jr6cdykInVqNDtmM/4T2NUfLp+LreT4BM9JqdMhmACgAZqTV8JDNCFDo20Ezq/EhW/ChZhHc5UP+7QwAhfa1S8un4ut5kwIepdUAkc0QUAA8SqsBItvhchtWw0O2gzVul8/El93e2tLokO1wdNtqdMh2ZTrbG8hqeMh2u9Op4SGbAaAAyKJWw0O239meGhyy/c721OCQ7Xe3p0aHbMZ/AmCtWo0O2d7iEdfYkO3d3m7W2JDt/d6Ia3TI9mU+24eo1fiQ3SlsZDU6ZAs6BF5Tz6XBWUxWQ0M2oz/hd9v9zzhqyRoZshn8CaatIzQyZDP2E0z7QLEaGbIZ+wmA82s1MmQN9j2tBoas2dmYGhayGfhB46enMQM/aPz0NGbYJ5imAW81JmQz6oNGW0NCNqM+wdj2t/VM2n5vbjQmZMu16m5o2tlWg0LWlqkE+luDQnanpJHVmJC1fk+faEzIZtgnmCbqYDUmZMv96vA99XzaMp9AyWpUyO5wiKwGhawr8wkUoQaFbCERdW2Y3GpYyLqyN4Gy0riQdThGZjUqZEt56vbxoFEh63anU8NC1mEI3mpQyGbgB20gjQpZN+6ZNBoWshn4CaB2iNWwkMX3gC2fiS/vnpkaFLLe7KxxDQrZcvc6WuMaFbIZ+AmA4281LGQz8gOUp0aFbEGF2spTY0LWDzvKU4NC1o876lCDQjaUyQRnjwaFbAGFLFgqGhSyGfYJtg0KWQ0K2Yz7BNt2r61GhWwGfgIgSVsNC9lQ5hPoLI0L2Qz9BJA9YDUwZDP0E0D2gNXAkA27Rq2GhmyGf+DS1eCQzfhPAOkGVqNDNgNAAaQbWA0PWXxv2PKZ+PKO16mxIZvRH1QjyWpsyA67XqfGhmzBhpAVrLEhW7AhkFVhNTZkM/oTQFaF1diQLdgQqNViNTZkCzYEarVYjQ3Zgg2BWi1WY0O2YEMglcFqbMjiQtfLZ+LLO46KxoVsRn6AEtWokC2oUFuJakzIjmHnSNSQkB2HPStRQ0K2QEIg/8JqSMiVitcA/XIaFHIFFAI5L07DQu6At6fToJA77NynuXwqvp5VLsgFcRoWcgds3zoNCrkDdlWchoRcgYRAlonTkJBbEs3aRqLTkJBbEs3Q1/V8FkwI5LA4jQm5UvC6fZnC8qn4et6cIInFaUzIZdwngCQWp1Ehl5GfAJJYnMaFXMGFQE0fp3EhV1hD7ai308CQKxWv0bf1nJb73dG39ZQWWAhUF3IaFnJ9mdK2RnQaGHIZ/AHRGKeRIVeQIVCLyGlkyC2JZm2zyGlkyPVlRsEe1diQK9gQyEhwGhtyhTcESm04jQ25gg2BFAOnsSGX8Z8AUgycRoccvpNs+Yx/uTCHAA3UaXzIFXwIpC84jRA5s6N1NUDkMgSEu6JntABEIDXCaYDI7QBETgNELoNA8ADQEJHLMFDXA92lQSJXmENotWiYyGUkCHdGz2iGgtoBU6dhImf3tqiGiVyBiUB6idMwkctAUAD5Ik7DRK7ARCBfxGmYyNm9QlROA0WuAEUgYcRpoMhlLAgBKE4jRc6WLQrUi0aK3A57yGmcyBX2UBNAcRoncuV2eKAVNUzkMhAUQB6F0zCRc9jEdRokcg5HVpwGiVwGggJIRnAaJnIFJgIJA07DRK6whwCp32mgyBWgCJD6nUaKXEGK2tfLLZ/yrxekqA3POA0UucIfArx7p6EiV6AiQHZ3GipyBSoCtG6nsSKX0aAA2NFOY0XO76hcjRS5UvUasMCdxopcwYoAJuY0WuT20CKn0SK3oEVtR8dpuMgVuKgNLjmNFrmCFoG7d5xGi1xBiwAm4jRa5MIeNO80WuQKWgT40U6jRW4nu8xprMgtWFEbFnMaK3ILVgRUl8aKXMGKAIrmNFbkMhqEYDGnsSJXsCJA13YaK3IFKwJl4pzGilzGgwIgSTuNFrnCJUJrXeNFrnCJgILRcJHLgBBcMBoucgUuAiRpp+EiV+AiULLOabjI7SSZOQ0WuWGH6Oc0VuTGXXhBY0WuYEWADuw0VuTGHUNXI0Uuo0GIWuM0VuTGskeBktZokcuIUACkXafxIjfilAen8SKXISHccz2dGRIaAGvXacDIZUhoAFxZpwEjv8Mh8hou8iXHrG/vf6/hIn/Yq0vvNWDkd1hEXsNFPgNCA+D4eg0X+QwJDYAr6zVg5DMoNACGqteQkc+g0AB4il5DRv5QZrS9n72GjPwB27leA0a+FLsGFoDXgJEvJCKgFb0GjHwBjNoWgNd4ke/2yApe40W+4EVtC8BruMgXuAhYAF7DRb6UugYa2mu8yJdS14Ab6jVg5Euta8AN9Rox8qXaNfC6vEaMfMkza28MjRf5PbzIa7zIZ0So7ed6jRb5jAcBqq/XYJHPcFBv25nUXoNFPsNBw++2/5/BdfrLejb7sj/b6tlrqMhnMGgAbFmvoSKfwSBAUvYaKfIZDRraRRG8hop8KXINSq77BSr65++/zZc/p9tjev1/l9fpr9/+9x//+O2PPx5fn9Nvv//fb3/M5R/d71nqb//7f7+5+J///v5b3N/lL/3/WP7GqSx//fJ3+Xdjlr9D+WuX70XXPP+Nvm75u3w/eifl7/L9sHw/LHKH5fNh+Xxc2o9Lf8aR+mnoYWnZ1a53lh4WIamE+vKwdCtV914e6EUNSbb0ZUuS6SVStd7lgb5M79PRC6USp8vD8ls9SU6Fd8qDM/RAH3kaVxqQnt68p1dOec/loevpwdMDfadffsLQRBh6i5SFtDzQdzw9BHoYlj4nVnSZRxpnS+Ns6dct/ailH01EtuWB/sXSv9AYJopHefCBlgp9J9CP0tClcPDysHTD0QJJpuWysuijcelhOtPKQ3+gh6XPPtBHJMfTOAdqFei9Qk8f0aoP9IKB5jTQ8AYa3kAvGHxd2/QvtDYCdSPQgAda4PHIoIflOwMt46GnB0PfsbRdLH2ZJnfwy28NNLwDzfJAwzsMPT1Q85H2HXVj7GgH0rCMtPdH2vwjLbaRZjldCr88kBya3JHmNF3vvOxpkrPu7rqr04Wvy1Pd1+mK0eWJJjbfO0maoaoGU79Xd3e6RpCe6vds1X51qx/qFj+E+htD/XSoqoUGKldWXJ5o4eTqecsT7YRcmYqe6Hf7UJ/qb/Trb4xVSR0O9Ykkm67qMtIHOR2cnuq/kY7OqZHLE63armqFzPxfnrqqCvv6b3Wc6ybPfMDlqb5bYqAtT7QSMwNjeaIpz2FfeqralVZYDk/QU/209t65KsXXT+tIujp+yfejJxoNX99yURfxcTlG8/+lY/WPt9v1g5+XqUpmPTFzbUzQcH4VzWzgzWhj57qNQMDP6UtK8EJCXRlF9bYk3KY/pYRBdP2A2j2u8o070cyCZseX6+3BG6aAw9rQWTRUx9Mp/S9r2bGGZpku53ea3+/n6c/pLAybA3/bQ4dG6Xj693O+TT+u98d5votuODHX3QFN1fH0mP8UVlW6vLa2HOoOO3RVo/RV3xg0D8fX1+n1fXqd3ubL/JivFzG4Xc/6ZsoR9neEXD/Tf+9ihkc+VMbtyMoG5V+n6/k8nTZdEiOestn+tphmp/iOSXnfQNrbY7rdpvtnbC/mwHRs9nwPX+oslk3v2Wp3pE0dnbKedKT3sEPn8/XX63x7fN2mo1ACKaS6rmu77GDjqn1FP3JY1KUfyJ6p6qsfq0oz1VA3cGulvswfn+f5NIulHX+UDc4AN0dufznFsY17Q+3SdH8t22EWzncScpsety/ZAza/ftx9g+d9ukV1KNZHHIm1fU8HjNmb58/zUa4xE9gmCj3UbJfj+es/0403ZWurOh31wCWz/7D6I/VQNOsTmQ2WTP/MItvvw+t0P93mT733PNcGA9Qoi5C36fh43sRuYe2hmltaiyFMMBHTkXY9jusxCw+a4+VLbr2ebz1yHy0ckn+LnTuwQ6Mn43E9aX2Pzvgo55vR5fu2G3bknOeojI6iW6Nl3ergHvn3+d/PSe6QseMt4az8+5y2x9vzslHI0dFip1DY+e0/j+enWA6j478dUMvb8fJ+PX7OLf3bD0zFuGFfRvtEGfkWxzs7S4iHwFXs0FT6mNktBu7u3PxfdznhTpyucOhyW3r7j+lxfD0+jnIU+HkyQDWXBd2n4+304895+gUWYkKf1375A9waStx5vvyUcryQA8+yhpzGWZ0i0czS8/tDvYr7PD5OPz5v189oDszTvSV55C/shv01wCRXofK1uU3hv1nXLWnNLnLt4MLfffn7Iy6c17zzmlKteHG4/bPUpAGk8csn5IDVTm4drbG7WmjRt2SnM/Ryjrfb8ev0vN3l1jOWt/awtTS3DX/l4GGf74/L9VWaeiM7joOD03r/upyyhn7o/nJryFekCG6v5+OHHC3eHqvq2EzpKOEi9fCdX473KW4W8aM9N5CxKohN51P65VNcbfGD+Xi+SwVluYJCmuAlbdXpFU24YXvAQ1u9CJEmmHV86NHmyS3v83/ktDN7ocKEdOBbwq+jI4GExr0YF8Pe2LAhXiCEppy3uJVvUzzB1Yrm29B3yHB4md7nyyNuxftxcwQ64Zt10At+id//8yhtM647e4LOgq8wI7LLXq6v0jDjGs6NcHajvyNOmV5Y+KjV1/TXMXoo0nbw3HYg9NNBF+Pl6zHFwTs9P5Krcj3P8RiOA/kZn07iVRIzkGMS6F1Ox7hQpbsy8JepCNgaKrD132pEwIaKU4VqGBPmmSOGO79+fJFjYvhiDPRrwaEtk4VMlyRGeqEc1eiHGj9YNpBZXRWIimXRP+aH3MkdX+zQ3MptP+b7XemBnnvrBmmz0/HyMr3O981bGW4rBngIx/YniRMFLywMeNSllnGBP6JP/5qBlOPWn7QHfg7B4+N0lJYyNzYJ4yRQIKBNGkfx9PP+FOBkb5lGtGNFzgib75EmPJ2P9/v8Fg+K/GbfeEP8zBrhSJ+n4+X5GRXbdItGzv0xfQoh/MjNuZm0UeCmiAJv9/P1V3KUlGHnhWHXefyeUUYylhBoKKyuziGNfzpf5RQ6AZIuoclmw2ccidv88XI8p6U4X94E2Gr5WhgOeCyymOvlLDEVfliE8E0nbtPSiY+rQi8N9xvNN52oYhpWrDVsQww7y09Kig7V8yxOUsuXywChZC3o/ogbVsjhqNHQw1dTBma6BYQZSRSpruq9r8HkvqI6vV0DPxWsxysqOsDHz2jlXe/zZhj5KAZ4ZCUJf2f78iUObRrgkHOMpQYl13hajdB0Fd82NVJn+jXSVKNPvp6QEFdZu5KtwISqNpZax7E8jGGvwkiBtmRxbHIJru3Keo0OYkuOP3A58DyochJU3/IxO26BWRiIUIK226jv2QRa6G6scuaPz+vt0eoRx/0MhG+1pFaX2BhZ6LsxQZeov5tdCoavAHgwVUk/p6/mpPGF1O1ttyqmDTd0PdOjvfteUgtAijuJC/l+6kFfDFvSffh+Se9iHtEPYWOET7sqDW1az9SxgUgvl5MOq+Z6ZGoNx564pGi+NQ+tjkN2BrqkqygVU+BmOhERQvUJOhjvYwLjsfWUfeIIQ79zbpGIx/X+uM2Xd6G9+XLsv++G5op13Lzt++9n/fkZV3N7iPlWxdZ6/P9ZxZQ5MOss3g6pJRmfH/fpJI9Afgbayu5wO4drkne+nqIlG0XODdPCG2ECwohs/P/P6OdLR5ljMBQhcgGfiMlhlj/fcQzWQt8+NY1KWON9KUuBjYhdQ1NrQKeGG4ed+fp8PiZthQlD2YtRwu5WEQXx0Tj3bC2Oe69bxSAtzVe1/ebdiiQpgAf7e3LvDQFRxuxNYxQpZyJakLw7xA6EgcHT9fI2i21u+DbF2H5p+LwdN2EjPkUD0e6GkUhkYyV/rSwmCvb1O3v5ctkalD3HYzC8L1AdvKud2NV15QZsVOyDRYJyU7mJ3d7GjLr79jwpfNkJQQcYTorNo9J+ecbm0r0Ngj2E3dvrU4boe+7JWSIROOIneuK6eV+JBrBvGfwQ0RS+A4m7YGmZuLomTOWzeXxmFGilEWh3/KjoOguXiJDQ0Bj8xNmXscaDG2K4TYfNqCJIRXyaYR5xnmG7JQtswzQtv5vTAbCOLUK139gaO7ZLIf67itvucxcElQobMEpG02bkMwlJG0WSwAj7nntRHp4ZpWW0w18UUOdESLmDgL6U0JofjsEO2FURcnSQz3JO4YCh7CJkOs8fOfaFZ5lP8q6w5F2ieRbHO0Z8spwWacF3YqVg/DNLeJ+u/7rvbwUO+Jv9QYrSPq/xeNkR50RY9tvO3fs9WTy0A6Oki6zb8fOHHGlBvDHQEl6bN1l2guhg9ufrx/Xxcjz9fAok1xuhbDCilEXMOc72+NqbMbZJd2X96/oip4ZPdXfYV84f8+XH8f5jrx98IcL46iLteX7Mf2ePidW9/3qXFJ68Py7T/P7jJVoEe10VYeT9GbjEtfCx10OOfe2vh8v1tiuJGwj7O+9z/oyDd9k9vzkyvr9ZypF7PM/HOzh3B24jdzimSfLe079+d0pycO2b7Rz9o92R43S8/XV8f1w/f11vr3vLg2M/2FXK4h7TX3vqT56gu5I2nJRBRLL/RuuWyhT75/DN2KTJlzpTaAgc2aitm2QnQWv3+134NZ9fT8fb697mFUTnnelpURQMj3xhRtPpGd1x6RvYwOZjJJr9SFGL0cEVXGTdjr+kOL7IcAB3yx3pOHkGWwy5YVydt6MKO3OuEVYzufm9YRUavqY9XhNFQGx/+9ACei5g/wUSbKT6z4kFkMndMkcNV/ue8ifDuKY81XSpmj7U1QQhD5ca/dYmOMlJ4wO0n6l5/qZYqnygISuYmst970WAFx5xtfH01+n8fJUTZbkeHOASfVV+rpOGACTLp3aPWb6z42hONCJg2+nlKUAcZ8SPQpc/vuIz0ftVn0Mv7AwYSH6d3o461MpjneOasxZq7hgkVC3SXq+n54fSNl44gD2M80QbSgGbQUy9g7h1aXk8n6NZWMJM0tIVmO+CV0AxkjHDE1tqqNdCfkcRMf2VeNGvqDdG9AZu+ywK2N3CAYAAYRGxDbwF4cw6aIxurFqUgsDFQb5qlSbtHU51xxP8OcWvX04KwLU8YDfU9PGaN05ZGOMapIexuPobMvduEIsX5leAkbG8+Ug5mCOxAkZXFXZNYO9rMnkfKrYKcffX6XGcpV3QcUqspYQiW8l/EKd9TZyY66fev5ajLgOB3ANBiiP9wkjnywiRmde4LbZAMDfsbM27t67GZixUGQsd7OWrpc34oRMguSjKKMjrFF3CaEyf558yusKP2p6SWA20FloqsOf+qSPA1NVcZZxnQdL+aIMuHX/HHo/7IqUtpOeHo4XpGiREh6m94yhAD7kO1H76K464dC14eqqjogMOEkelpCZQyIPUEDgmOTJht+dWec1QdjDrj6S0QvheBCZ6fBgvMlKUKvuab3FXqzytjhPEeohnbUQ1qQWcsdlDUhXJkrPFEcyat+2qxdlDwKSKm9IqVHx4AYnhOPfr9dflfD2+LrFYeSwK/BC6u4myIxABPq71fejsWNPZTM1gx85Gkt3Gj4X/iXdqbN/GRgW6CsMPqX1pIkJtnFNN+fU45P3aCg1yHtJIh8lI9SVGKisxwjBSgo7ljAuzrNZrMQFZEEkCVIQcN4GJ8Ri+7jmoulYeMDAtQopSOWR8sgxciDk9e6NNhXkIieI4P9yLlCzMPfsbyeF8PxlonUlBSoTIVYfbJonYnguBpyLlq31x67b2HcVY7rXP2KhUczw8vdNSoWScZlfzu8mmczBuMH18PmTqBfcfrYd7Ykvzt3zYAqXHBLySo7N/S9Tb4k3m00er585z0h/ED+IwzhdF0BZxoR5iB9PlHg+89+ma27XQt15Qd/BsZkENJciJvFTIBDMESEwppAU7xeOjnYXIWZH28Trjtwvi7ZDtUwR9pry9nJYP5fGFmG9/3ZP3eJxxxwS3Aqa4JXvs9nmb75PmpluumwMe8JuMcXJC/khZAiNhESOEIqKciyxjIlLkexgv2+QRd3wM+7WaFR2gNZ/nUDl+fb+SwFefEy7V9Isf0/1+fFemHqdsroIg6S0LusiUkI7Diz1VaYrvX71KaPdlcVKvcaTTQuR7uj/mjwSznq4qH47j7wECcLX95TY/pg8Jl3JfOkD/i0SoRcyVkD3AtVOww/tXitKA093KcBQcwyTqrqrDGH4ieYgmTH9Np2/ZdCL2CjGcRRTMMeRaooN0hCIlEUMVymlEph9FEALk0m0PeY459uRt2aEemJU9ywzEmjlQMUoPceHpr89j/CWxsXuenWkh+Tg2jfP/Ml+ON5UVyY8SrFozDJir1Mi1KLhl0PWPzc/HWZp2BzHpeBuWps14IN9EkOK+CEhpbrI163qAZTWW1tuAB5/rAD3Y2LzBU+34Fu6JptrD/IMcLxK/bni0iWqV+YqL1Xpih1rv7FDrpx0MGuvkqV8vv463i+Jcd9xe6Ylv11OMJsBcjsX3l0qHG/VjpeYeIHz8Fm1hmeDWi5o9MEq9VIiR6pNNGx0ey1+ah1qectnAdFhSyUUKURFGS1hhfZO1uh5t+HpO1YSimnFbcwbpX6qTXnWDrZivrbXvatnJzkI39W2ezsKcDpxJ2Vl4mOeGygYTNl0tdlcT1PNt28sTAz7rk68QaO24G+orQws49ySzlROPXx2E4mUgKzPzg5Vrw4NhlmqEOmjQv80yi9kPwhGAOGNqpzwIYb9BrRcbnl/O19PPbQo35zUHePpHAQ99UHB3DppfpaGmHPIzhhIN/I6MWzzsWwnxPEOAyshhTPztfHxXDE6utCGrLrZ7fBw/pbXC6eS1ii/EZ7IbKUMHPJ2UspJHwtjGWqLpgF/nGo/Qk6y5wTekpxCKx2+WuEqyfhl32mAw7+36l/AgvRcQJfT1UruP42V+UzUhvMAAe2hs6cKTlvuYw1rIczWI8Da+5aSPt1m8SMd5LAaGD9+e5/OGV264AvFU+zNAZDsJScwi6YpzBJnU+1LaE8mYH3JfWF7jYqRk0hG+zft0mW7z6btQJoe8YMxokbXBGILIBbcwqWFpv1vuSZQWgjYm4SWyFwIogdm1ikGLkob5ooVOt+bPwtfiwpABKNizSBIfn53hEQuPJxT0tbh1LSbtVqpMzVwm+Czflrg8VfMD15aMP3z8U9I6BCBzgOdAbKlLBUi/TwQ5IByTxCy5YtKa8SLtAKLDsf05cwzlO/CVdYAWfGp8jYv8sanWIJLNOmiEFQGbIg1emGJ7Cyg1X4AV1QHBJtpZz4+lttv8ci6RYWkLsfdwZLs6yNWJ4loBK2EfdhAZW1vDzC0vKnJ2MLSzikKcCi+gkm5Hh1VJS1hv26leBL12FBGJSsnCEmDwwmDtIIgdZWxpp2J4oZu/NIWFQYTPDQH8RUqbwya49h20HKKMbZKhExUJDxZ24HyN+uL89bzM/35OMqbdccxhrTzuIVP+PQ7HFM9dIYQf26YmivZ4E20zF0QWzcrKqUVuTc01NWF92v2Bv1EfwAvibo+PCykPpK77QQQuYR2cjTSQwO4FPdpAeuRGHkpj94PkFcPllgTikGgQJScNVm5JjGaMelEb0cCIbG4s17tIeexgOanccr8qtYhfQuLh+39mSa8bhL8Jw7c/jvePq+RoGMMpyQ4dzrHlRdnEhqPKnnANDwf9h6owHYRz4iAcmtopCl7PtZMns8hDjsIPaW7yMxmqgh/zazxrpFvKUSXoU1YC5KZEu4BRDzBEWwU0cwqCUK3wjUnGlkvpepkrBBfL4/HZKFQrsnvhCZUaL0UGVek0Hk6AeRXyLDBcCQeKVwXyzocVXHTr3RcVphpqKnS9hMfViJKrN214iG7qNDDkiHHdA42Q+e0jFQaSkWqexURF+uqtF4YiiYaANFxBf367XC9T4xcG/guEfMKpn98v1w04xLZcrRpoIcG8iLhNf6paGrxeja9viI63pkNheWRvIGRygAq7CtkENiwnuw14NZKAUjxTSrBcAu7Cp7pwoueIjqOCl/jiifmS9vP77fq8SC3KB6OzFYu2FWuxNSRgKy3eQe01X3I8MZplDXTYiDp46xVUlQDs6hOuLDun2oT5X/jC4Ey4nlBkAw+FLVmCH/22XsRBysJVZrKp6SWVMJdv8tz5HYUqc3qIo8FdL3Ix660H67Ux8JjJQlv0wiDcZgch4PmypfTwoJeD8L82gJwoTHioNwUdYO2tRKCSk8CVBGSx5kDb+dz0L0UBBVgVUEpoJpnypHWsjRMF5GN6nXMifyqbs4UPOTM3wKj1VtKmAjBX8wHCGIK/I0EyEQiBLoEQkDdxkwUk1AY0WYWwS0oFfd2Gm5wIGsGkaiSrSeERJCWYaCdEft7mj+Pt6x41LX5t0VWI3wq53xQ/F6ktFlpk87195wJ3pXpYACe33ty6wL2mHmuI+3L3QaNiCXd5vmkOqizyLkAOGMloZwZyQgb0nEnE1iQVsZEeMjZJwMbH96JqC47PkwDATAmCNujwml3E6ITfEIQ/hK2Re4vfwZkCsKDWfH9N6VUfUW/fH7MoSGT5KA6Q5xMlzPd/JdxcrCJOAe4Jne5MNbPNztucs38njSpu4EHcOTa9Hl81WCwmASITc3SEX2t1ms3GMhysDzBNdr7fo7rPu1oiCYIFDAlXsXlUWGokObmoXglnaq6C2VEwhQQmDX9eHpBiBIOHh88io+H3iawySKRJHLjrTZOXOLvcwsDplj/HDykPlbUqreFFCux6r5GrtrGDxcLTyhbajVulkL3wc5o+j2dNnOOJmB7yllLby1Pe68WL8xE7pF7D2JPbW0tVrbcdGngG/Jy+cghP3ybR8VS2Hq5UUH2Uj3S9E9JAzRel5OoPkiohQtQwg+rnrMaI6whPV2p5mCqY2m+2uRe3wHUwYep8fFEQO89G6g6wntH5eH9s7ivq+LLuYc3OVOjq8ZS1nZ0IhSGd2tCoPJQ3QCujNDz9iMeTInOJ6ysgmb60T0ne0l/ntjis8HWe3o8yldVyIslQK1nX+1eJnjSSYhshBrAJknTcbOsrErGSumoFvUMFkA7QtD3PUgUFYVHAVIhzdF7UTVSWV6sd1rtc19taIWvkLFEzJ9K2D9DFzTnOYmj48VURBUsYRWWAWXKuLTwg0x1MqoYc9zsctDM0dtrz88cR5uNqxOUAOVZJErgNToR2oJmRBABitRPz3MFTsYhYYtvxuFLp9QK8hzBkEgLqTYhYHcx6SgJ2c8BE8AHGPpMYSvhTFxuI4ClU5UlAK4giAu3wKEqtK7qtIuViNqAdnySkSPJ8ed/OhWD8wWBjEnF7XhKBtnnDg5gQaG0lKVShV6IgIoALsTrePiPSKiwuegGR2iwFXVUh5gTiQEkE84qUDEH/gFGPJAOHo73oCCSxkBC10UVjaECnxjo6p7L7RIYSLHGQBaVb02QvBEsBMlFaEAFPfYYuTXKGpCskVC3EY1M7dbGs4aQXD2l/qWVBxuM+iBsi1e6TbilnTzkKyXgIom39uY4POXY7UsMWVMuPQEs8dgeZ5EWM5MRzpYYzsXK1bWXlcdt4MS8I5q/HOh6J08+UuXJ9qqtwebQWUkvaVCYnlNsB0pnX1q0ApBGEKpjhGoVIV8oJ+LLbWcZbFpUTqYYHbE8tbbf2uqh3fsCG/iLgPj0eaiE4gZge8OlWaVyytchlwHbP9T3hl82yI06cbwdsB14v71vPQRSCw1N/jafqy5e+wLjnAUTXU70L6Pd86DQgQaPp4QZskZAtz3Mf+zXHAguRnHBORva1nDRcuR9HRT3mcSXSYLjtKS4/FbLn+DAFVeChHkW8Tp/q+kTRCViYKzadP54fl+fHy3S7viXyjvLieLF0qEyTmMdSikOlivMEAeh+xvbbHSwih+s9xzQaSA9GWekCzftndEtTwOcRzT4ZVGGLI8AzLolZRqVxsTaHWyAxPYrYNuUOaoD4UGyaoYdyy8V5urzL6bXcXgwE6wRogUd56Ypypd4Nl+JhfCk1fm6zIjn8GyCAHBsDU9HygzrQUR+g1xklcYtRx8o40OEJUA4QO4jSlny2eyOAxxMIYakXynSXkS2R+AhpFx8J9PzaONJcX9Osehi3+5hu79P15V9R8asat5y8US+PH6oXDgelkabNDbuevGdzWGkzcFNP0euSjBAOjuIA94c8CYQKWcwhmJAV227VqbgWeadlQ4vyqlHQqlXFllGSAXeuoKsZZTWMGb6mVr4EqcIdWXFxS/pJEDfaOwfXVtSh5z+SkbqpkiN9Zjpc4cGud5flqW4joVQjBCHSofQW3avrL+WlWW5YDtDQTu3PW0agFXsNpr5uj0ROix9gaKJdMhsRwficwOrPWeSSd7wl6RkeFg6QwpGFqPQ7y3GtkUyWsfocPd7jSZom20tElq+3EfLH8jcEoMFGhEhIPWGtPQGKPWWU9pRDX2nWjpjXrlaHIcx2ICtiqJU2OnppkjyS5LEyyQ+19GxfbwKsHej6eslnLaDXmVopw7gamKuEJ1PJVbbyDG3NCLaUbhyf1nzfNYG2ZvnWZNmar9q5Qy2DWyV7uMFQJXakx7g6haloha0haQ/CrF0TnWvZDrvyoOrFifh29sv0K/ZWVcji6egwqrTlJXM+AaUme+iwiRrzaEtz7w3unyxJmzJWUOVh02TkyrfgmazkNgSo2Xh5e/QSfKohHHi5vb4kHaBBNFHL6ACN/8ttkw3tBBB5gM4nWeilqqUMNAowZVlXpmZjmHq7Ey6dWKRvZVtukQx0gA0QYoxyknmgjhF5kwhoWoy7X/Pjh4zUeGFm9v0asUadWCVFT12KEvxsaBuuArSuDoJO4yBCdX17u0+Kw8nrXRAp2xBa0B0gt+cqCWU9t1It3G7XS7OcdMePTlxGKmFbH7OiQxmOmQYKfQWobEnI4/r5Uw6iKGkN4Z4WwCZaVq4q6dJavhCaaA36BUdBIY3ievuMRi+Avv0oMmvqGWZgctf1+WgQU3mhUgf3SVQ+v26KVNNxonO9pbinUxIX+q7SPtRFyR3vjYGuxOfxdoxjcp7vgloTRNjOQjQuNpcRXi+SlDoIZuaG6t541jJAEC03bJiUPPQaIIT1edTX3Vu+ocaK2RygakgifskCf/wUHFwNsler6ADRqCzsqpJZeUTHQbf8U+dBeMGf6Ku746CejCKkD8nvJfWHmoFCF1HUlOsD2aBdD3Gcz+n4s0AHT+2oG3E/CxnxgR4GmCG3BDbF4HNHfayF3w4w0qxq9UnFJr1XtOk+521FRsvV+gApx3S9jtTLrCUcTnUvD7J4+RtAfGpTSIozaDzZGwF6jFuskEfxAgSvc7vWzR/c8wqQrPB5vZ43YBqH5jysz/qpCuAFUfzDweS6z2teKSmRd76kSyXL0pEWoAi/4Je/TafjZy7mlIDeR0rpVReQ8Gs5INsnZb0lE/Z6m9/niwymyiu8yzRiHVwo5Y1tIPBsGIhb2kcjbVPhJwib0UKSAGO1y+bCTsCnVzSoVVkjw3EwT0Z0wCqleRUtV+hkDCx/6WyuhMDyl4pQ1EJm5NTUOv+LEl0PBXogRV2rXPQrs3h5qH5nrb9H8i3druCqm723dK5/zsoXs5zmM9ZSWD2E2z5l1DaI+0Qc/O0NP5Gf2D0NbxjraMBZz5I2V+J0gleK9nNuW63j21MtHp56G2CybxWyuRiN6yKofXPz9NOKSiIYW9AAYsEWeXaznu92PCmen/oU5WZbqGBPB/mbQlIrRYnzrQL0cqKY5/aqHlEwp4O1jGrjjxQvOqm4pAgnQ2jipvK2DQ9oenh5Sq0ButSGkcFoYQLDWFU6Ds6n5znnVG2uC+aRBOKEYgj8Nr0+TyrxhL+Ir1oJLatUlepcqg5nba6iNKw7piYwEoHTDNVPwQOW0GnxityZdwRNrMV8zFroHxZ+KlIVv6fnXAxHigXfUF+EvHw1i73xquMEXTgYXSdRW4YBz4clv8DBwHCRo2ADnn0I2VmlJa5GH0TJIANjO0XOpoSLqCLRQW+7tN4vBiFvg0Ua67a5vKznSckVhnXV8seFEoosdF2uYCVC/KHI2FxnKAppdZAxHFtPv47Px4/H9eekCESCXgqj7UuVEbne+XUSBOs4U/H8OjRmZ8FlsZudxGsdkp3iILtvkQK2EvdqyZPEqdqLLLUHeNVrWFRpabq3CQTes6O0GoKaNzOIxQyDr4s8YHIKhjK+fnER0swvFufmd5P9fQ0rsSRhGQMpDtexEhts52Tl0prJz9xdhs7JImerwcROhRyv/dsXeGWFfqhEA8pdonjRQMDmUOvFMlh/50DKpUWkuyoYbjAVdWnaui+We+gOxsKSgFlVx7Cc3DtSYYSRiE5jhW/7sIbY8Q/kMm5y4Yqgcl9LavYQgCAp1QS8Z4Wj3GmeRAVvMEru+PWGbvYTOwp6FVs80vLU4bGWT3A7iv0RfYoEMbzFhSeNQZ6y4slv9BR68DuT+XjeLhd5VnWc3FFjvTXUu0Z6V+KMgSmF5RdUhKPjyQ6G6tTWAmK1hqMh6tNaG9rUNEYDedTlN1MpZWnvMq2Ad9afMvAp1t1YDc5DLXcBw11R1Kxrovfc5rZUigNfTHxLYQShnUQ8tVuzO2uo3VWQwMGsS+3Vdnxs6n2GBvLgNq6p4R5NoKsRA/EPAuSzZEnLlQcK8OMSYZglt7//nD8/dXNOTYRR0dvzIjJI5Hkk8iagh7rKeOhyT14Qtztsw24ZiZYf1QPEqmsCtjI3RKaGXYkbNVBcC7EbGMteZX9dTr+OitzHHZYA70S4H7VPx6vH0HnoKgXF1GJWBjqiSebGDuUXPFDpFged+vvpGLXe65vOPOaheg8X3dJ6A4v2vPSlJQqNh6vvHr3oD3nNH9cP9TrRqvPwfVxFVCtJmcd8eliAtbRv250dJ5f1EKlt5WAJmiDO9b1Px9tJBZo4a32txQNN+iLieJ6P990qzfy49hA4UtJy61bxE7HPHNzfSlwOzGGZog4GtChaMtf5awoWAQ1oE2jBbV9EpI7j/H4orNlBcXs0jGsWmY1rH0RIoN4IaOudM7baoRaGy+/Te/r/bNd/F0njvwfdjEXg/eUrKtK381WVuRJpcQ7mNggpKkUjiPKXDuvzRcamuRHNvxmZu2I0B5FH7GCCYyFViSOOq6ahMg4PENb/zh+13Kwcoc2xiNnEB3iSzrizoou98Pz4UFVoLM+kGGGGFzMWlkuQoyupwluOJzOMWGtvRG0KgHOFN0Icgxsw+hIgy9kGIwSYhYjbdPzYvpXlwZMRAjsbSfqlLA8MjTAtl8t5KjqNHUUR1L/zUklEa6Y4uwCirlrQ9pX4IGPTZxXziKd1ozc8VLejQauYv56XubkA+RDDQJUWtF1+fEtA6sIdVY8X+BLkst1r7fddd98J+ksHi8XcWcn1esG6Zk95QQjtdib+IREDy6GMgYK+A0V9RxiHvn9T9VzElCBlflMZ33KTc8A2b2qnY4Lc6h4oujzgDbnIaOVKdzw621NYu6e8IQNvIMxCdTil4yGACjoZfCRsebF8fgfs3/x4PtIN13KdCSAT8sTu81kRRTp+BBkaUEPYoKE7m5cbihMuAt9oTus/B2Gjr9RyDLjGwZezMjkVtW9K48A7zDJj0uiemRYSyZUPLs7IhOUKDArv6Ti61+P1s0pRcb7ma/KoK4wjYZlbHLDnZqvFmn8rMi365uhxjAkSC4HAVgd5OA0iZ0KejPI0O8nfGru1WGiro/zFYUiYyXymq9+/mXDu0mOjEMpsdZPzkbHpkXNldzKkeMIprLxcpHyT1MRtBgxWKFqdE7VEDzvD/Z9oame/RTQX0Z4DjIil5k9FBLYcphlgqCPBgnIu+cATpmAp/m9h1DIJmi/l4E23ywCSuOFpMgESDSmD+OvxI07rDwWNW16FOAyV9ASnJZVQzOWEjo/HbX5ReHHH8eK+sjDWO8lW5A2vofQTqTQg+AVeArXWaIcRbs3k6/kLW7tmS8Bp3VDKg4hD2orN4/Ls0clR9q645+gAr5jLDdVq5LHiAeasJL9KxiM4OBbofvMBmwvaMes5umwpycwT8BEI7A2UBDZSDbnuAKH99CtPqQL5z/T1rkuHZziL2BLQOl4EpMcn3WP6NpWLTxY2vaOgD02C43wF/AKTUBxBZAk6WEEphVU3FR65niNuJrxGq0r4Dnrixj7WDSRtQ+PnfBC81GvdZ1WcWpB/uxVdgzs2SWoIEpF2VwEgXLyhWWSJm3kWhusLkiCPA759KGoWDnThLTZiny/bfEXOewoYwXrqUI3lFuVIybYjhpJ/Hd/fp1u6B1A62kJ/4b5/XU4vX63QZMcjM/iy1/vX/aSCL17QGXEVVVhbVxSdg9U1o+ZN947p/FIepRtgplpp/CtlBUvchZeWGaAX9Jiif6jcPMsTSgeK5Y6H6sijpbgJE1peyHykUggjnaVjrYN8qPU5cRhG393prEg/hfGE1O47tcuPWbhC2maNzDyiMwTCFI8fz4+Xy3GWC01cbdlDAPExT7eUiXE9z68ZJP6MT9LoDYKPh3PxNsxjK6xeCEk1ipf13OH2tEz8SveHZMmMZz2iOyF7IjKSIU9zew8rH8WRSIAjJYOM6yFF9QRCtR9oaa6dhsSPhwTXeb7GUK9OMTUHzUBn+nHVys6L87+v0no8gppN2fOkPhxkiwfoHz/le/BfpqMPOtmxvawz7wSkeajlDg7wEI8iGvcB89RNaE08ro/j+bipWeJE6uYBorK5eQsZE3V9KAcQ5hAyMel243IKABfK8gj6sLMkositV8j1Mbw6J7dtHAQ8R2uA1KKc0PAS2/x5VBVYeEA0kKMVYMQlC8qlWK/3uXGrhrgRuFLeq5XfrbV/cT3J/BuwYBXnbwx0LTRWI+1bH5yI2Xa1vEi9GKjDZGAm8vhybd4DGYSh62D5ByYKOefcEfaQRiAEpWtsmp0S8VYIXjFZr9MjnmWq7honOMGkKCakmU/EGYyw2A4uTivY+tCA5+03/mEQxQ0dhGujkFRVQ6Uj8upebiUlYY1MUpqgIkcqDX6b50VXTei5gWIpxcxhK+shy6nzyGZ1iWr9mwBRgSiniOADKuJUFgbfNODNzYtlHKtLVf4SIZTyd+nkpHICntRApScv5/2a9E4PxMhZ0wFrDkElXlTPsJbyoY/ohzrSZz3J6Snq0VNGUl/DH30FNIhYXNMfewqNxLO4KstqLdfi7Z2ttqdddVVlxTkIQz4ve7d2CaIgREK1jBZ1nXNKRkhPKjcGSwhM3I51WN93BcP2pV2mu6p2yTcTrHX1vLSqFnPOGdSPpemm4DBHm6AzWFB20V++axxtwfWCS1PXnIHoXpG64RbyvBTaUg5GSlUAQIjiLqMjdqyDUFgRpS6i5NNCbEkLr3grIhCJixujmABfZHybDSIuVu1g0RchDSeDiHA2PNmKsO1F4oI4AJMEnp/vt7h4m3tacAV2VgyX0ExG4fWVIO3s+Sn9JSeuVTvgFXKTBFYeOfUQzojj9XK8z6eUaCYj10KTQQQjtU911m5bAcIchM6hnjDLQbxQK6cd6i2eB+heKE5E89Jg4e/AkPlO+X1But/tSv6acDS5WqK4/YD1aZTRfAdRQgLmfm2q/1sO6w2QG/jnkbCS7VUxopQ7pFRHh2g+vui8AG7eBWgaJotOc/n4ShrIIBnpIB/JlBmJ3D7WyMShmj2HupJ6ktD1UJcsvWhHuTheVEnqhqQaGGlahG7IhjxxcoDF+UqCrDjo+Q7vDCzdsZ9ay5WL2RuQvdsgxJ31ewMQhUx/zQr0DML3MDAFJrXXN4T0XDtbCN5tknDFZVtdDX26WmfMw2DyLqmcT4mHAby/SdMeBP8bVnnY42Y70R+kK74nZA8i7oXX2vayD8GAgp5YikKozMme4yj4OtGUjvJ2vaXuH983pogT9Wk6GA1ZpKSgiAxU8ksv6CasmvNlCNswpHJqJQJTUzYIs6/XIVfPo15IXauG+qEm6FSXpeaKdqYWljFwINmLsLxU8U68VruBgOVSRlwyNQRkCV1iqkAu9D/fqJ7K5gVKDA0w+FgAug3Ex0v3DJBh/Ws+v56O8Sz/JojKNxoEUVORyGQVyFgZr3YB8bfUlEJtKimH12iERWFTe4i7CQsXhrI3dQQNL7DooduQ2708396ScfVQdzsGkYSImVZMyPx6ViLETcTQvmYiUuRPpy5YQfyAVW2ylOi4nCZVYpcj4RVCMARu1GtHBwIchrXecYU5DLy0Pv9s0q/b3cid6x4yKbKAdnok9488hFiLgPn9cr3p9jxjuK1X/vn7Wozuf//xz//+9/8DFp5T4frDBQA="; \ No newline at end of file diff --git a/9.0.0-preview.1/assets/style.css b/9.0.0-preview.1/assets/style.css new file mode 100644 index 000000000..778b94927 --- /dev/null +++ b/9.0.0-preview.1/assets/style.css @@ -0,0 +1,1412 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +.tsd-generator { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/9.0.0-preview.1/classes/analyzer.Analyzer.html b/9.0.0-preview.1/classes/analyzer.Analyzer.html new file mode 100644 index 000000000..8c626e758 --- /dev/null +++ b/9.0.0-preview.1/classes/analyzer.Analyzer.html @@ -0,0 +1,25 @@ +Analyzer | arangojs - v9.0.0-preview.1

Represents an Analyzer in a database.Database.

+

Accessors

Methods

Accessors

Methods

  • Deletes the Analyzer from the database.

    +

    Parameters

    • force: boolean = false

      Whether the Analyzer should still be deleted even if it +is currently in use.

      +

    Returns Promise<ArangoApiResponse<{
        name: string;
    }>>

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    await analyzer.drop();
    // the Analyzer "some-analyzer" no longer exists +
    +
  • Checks whether the Analyzer exists.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    const result = await analyzer.exists();
    // result indicates whether the Analyzer exists +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/cursor.ArrayCursor.html b/9.0.0-preview.1/classes/cursor.ArrayCursor.html new file mode 100644 index 000000000..b4aceda15 --- /dev/null +++ b/9.0.0-preview.1/classes/cursor.ArrayCursor.html @@ -0,0 +1,130 @@ +ArrayCursor | arangojs - v9.0.0-preview.1

Class ArrayCursor<T>

The ArrayCursor type represents a cursor returned from a +database.Database#query.

+

When using TypeScript, cursors can be cast to a specific item type in order +to increase type safety.

+

See also BatchedArrayCursor.

+

Example

const db = new Database();
const query = aql`FOR x IN 1..5 RETURN x`;
const result = await db.query(query) as ArrayCursor<number>; +
+

Example

const db = new Database();
const query = aql`FOR x IN 1..10 RETURN x`;
const cursor = await db.query(query);
for await (const value of cursor) {
// Process each value asynchronously
await processValue(value);
} +
+

Type Parameters

  • T = any

    Type to use for each item. Defaults to any.

    +

Accessors

  • get count(): undefined | number
  • Total number of documents in the query result. Only available if the +count option was used.

    +

    Returns undefined | number

  • get hasNext(): boolean
  • Whether the cursor has more values. If set to false, the cursor has +already been depleted and contains no more items.

    +

    Returns boolean

Methods

  • Enables use with for await to deplete the cursor by asynchronously +yielding every value in the cursor's remaining result set.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    Returns AsyncGenerator<T, undefined, undefined>

    Example

    const cursor = await db.query(aql`
    FOR user IN users
    FILTER user.isActive
    RETURN user
    `);
    for await (const user of cursor) {
    console.log(user.email, user.isAdmin);
    } +
    +
  • Depletes the cursor, then returns an array containing all values in the +cursor's remaining result list.

    +

    Returns Promise<T[]>

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.all(); // [1, 2, 3, 4, 5]
    console.log(cursor.hasNext); // false +
    +
  • Depletes the cursor by applying the callback function to each item in +the cursor's remaining result list. Returns an array containing the +return values of callback for each item, flattened to a depth of 1.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.flatMap.

    +

    Type Parameters

    • R

      Return type of the callback function.

      +

    Parameters

    • callback: ((currentValue, index, self) => R | R[])

      Function to execute on each element.

      +
        • (currentValue, index, self): R | R[]
        • Parameters

          • currentValue: T
          • index: number
          • self: this

          Returns R | R[]

    Returns Promise<R[]>

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const squares = await cursor.flatMap((currentValue) => {
    return [currentValue, currentValue ** 2];
    });
    console.log(squares); // [1, 1, 2, 4, 3, 9, 4, 16, 5, 25]
    console.log(cursor.hasNext); // false +
    +

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const odds = await cursor.flatMap((currentValue) => {
    if (currentValue % 2 === 0) {
    return []; // empty array flattens into nothing
    }
    return currentValue; // or [currentValue]
    });
    console.logs(odds); // [1, 3, 5] +
    +
  • Advances the cursor by applying the callback function to each item in +the cursor's remaining result list until the cursor is depleted or +callback returns the exact value false. Returns a promise that +evalues to true unless the function returned false.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.forEach.

    +

    Parameters

    • callback: ((currentValue, index, self) => false | void)

      Function to execute on each element.

      +
        • (currentValue, index, self): false | void
        • Parameters

          • currentValue: T
          • index: number
          • self: this

          Returns false | void

    Returns Promise<boolean>

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.forEach((currentValue) => {
    console.log(currentValue);
    });
    console.log(result) // true
    console.log(cursor.hasNext); // false +
    +

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.forEach((currentValue) => {
    console.log(currentValue);
    return false; // stop after the first item
    });
    console.log(result); // false
    console.log(cursor.hasNext); // true +
    +
  • Kills the cursor and frees up associated database resources.

    +

    This method has no effect if all batches have already been fetched.

    +

    Returns Promise<void>

    Example

    const cursor1 = await db.query(aql`FOR x IN 1..5 RETURN x`);
    console.log(cursor1.hasMore); // false
    await cursor1.kill(); // no effect

    const cursor2 = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    console.log(cursor2.hasMore); // true
    await cursor2.kill(); // cursor is depleted +
    +
  • Depletes the cursor by applying the callback function to each item in +the cursor's remaining result list. Returns an array containing the +return values of callback for each item.

    +

    Note: This creates an array of all return values, which may impact +memory use when working with very large query result sets. Consider using +ArrayCursor#forEach, ArrayCursor#reduce or +ArrayCursor#flatMap instead.

    +

    See also: +Array.prototype.map.

    +

    Type Parameters

    • R

      Return type of the callback function.

      +

    Parameters

    • callback: ((currentValue, index, self) => R)

      Function to execute on each element.

      +
        • (currentValue, index, self): R
        • Parameters

          • currentValue: T
          • index: number
          • self: this

          Returns R

    Returns Promise<R[]>

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const squares = await cursor.map((currentValue) => {
    return currentValue ** 2;
    });
    console.log(squares); // [1, 4, 9, 16, 25]
    console.log(cursor.hasNext); // false +
    +
  • Advances the cursor and returns the next value in the cursor's remaining +result list, or undefined if the cursor has been depleted.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    Returns Promise<undefined | T>

    Example

    const cursor = await db.query(aql`FOR x IN 1..3 RETURN x`);
    const one = await cursor.next(); // 1
    const two = await cursor.next(); // 2
    const three = await cursor.next(); // 3
    const empty = await cursor.next(); // undefined +
    +
  • Depletes the cursor by applying the reducer function to each item in +the cursor's remaining result list. Returns the return value of reducer +for the last item.

    +

    Note: Most complex uses of the reduce method can be replaced with +simpler code using ArrayCursor#forEach or the for await syntax.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.reduce.

    +

    Type Parameters

    • R

      Return type of the reducer function.

      +

    Parameters

    • reducer: ((accumulator, currentValue, index, self) => R)

      Function to execute on each element.

      +
        • (accumulator, currentValue, index, self): R
        • Parameters

          • accumulator: R
          • currentValue: T
          • index: number
          • self: this

          Returns R

    • initialValue: R

      Initial value of the accumulator value passed to +the reducer function.

      +

    Returns Promise<R>

    Example

    function largestOfTwo(one, two) {
    return Math.max(one, two);
    }
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.reduce(largestOfTwo, 0);
    console.log(result); // 5
    console.log(cursor.hasNext); // false
    const emptyResult = await cursor.reduce(largestOfTwo, 0);
    console.log(emptyResult); // 0 +
    +

    Example

    // BAD! NEEDLESSLY COMPLEX!
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.reduce((accumulator, currentValue) => {
    if (currentValue % 2 === 0) {
    accumulator.even.push(...currentValue);
    } else {
    accumulator.odd.push(...currentValue);
    }
    return accumulator;
    }, { odd: [], even: [] });
    console.log(result); // { odd: [1, 3, 5], even: [2, 4] }

    // GOOD! MUCH SIMPLER!
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const odd = [];
    const even = [];
    for await (const currentValue of cursor) {
    if (currentValue % 2 === 0) {
    even.push(currentValue);
    } else {
    odd.push(currentValue);
    }
    }
    console.log({ odd, even }); // { odd: [1, 3, 5], even: [2, 4] } +
    +
  • Depletes the cursor by applying the reducer function to each item in +the cursor's remaining result list. Returns the return value of reducer +for the last item.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.reduce.

    +

    Type Parameters

    • R

      Return type of the reducer function.

      +

    Parameters

    • reducer: ((accumulator, currentValue, index, self) => R)

      Function to execute on each element.

      +
        • (accumulator, currentValue, index, self): R
        • Parameters

          • accumulator: T | R
          • currentValue: T
          • index: number
          • self: this

          Returns R

    Returns Promise<undefined | R>

    Example

    function largestOfTwo(one, two) {
    return Math.max(one, two);
    }
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.reduce(largestOfTwo);
    console.log(result); // 5
    console.log(cursor.hasNext); // false
    const emptyResult = await cursor.reduce(largestOfTwo);
    console.log(emptyResult); // undefined +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/cursor.BatchedArrayCursor.html b/9.0.0-preview.1/classes/cursor.BatchedArrayCursor.html new file mode 100644 index 000000000..8e64be3b2 --- /dev/null +++ b/9.0.0-preview.1/classes/cursor.BatchedArrayCursor.html @@ -0,0 +1,141 @@ +BatchedArrayCursor | arangojs - v9.0.0-preview.1

Class BatchedArrayCursor<T>

The BatchedArrayCursor provides a batch-wise API to an ArrayCursor.

+

When using TypeScript, cursors can be cast to a specific item type in order +to increase type safety.

+

Example

const db = new Database();
const query = aql`FOR x IN 1..5 RETURN x`;
const cursor = await db.query(query) as ArrayCursor<number>;
const batches = cursor.batches; +
+

Example

const db = new Database();
const query = aql`FOR x IN 1..10000 RETURN x`;
const cursor = await db.query(query, { batchSize: 10 });
for await (const batch of cursor.batches) {
// Process all values in a batch in parallel
await Promise.all(batch.map(
value => asyncProcessValue(value)
));
} +
+

Type Parameters

  • T = any

    Type to use for each item. Defaults to any.

    +

Accessors

  • get count(): undefined | number
  • Total number of documents in the query result. Only available if the +count option was used.

    +

    Returns undefined | number

  • get hasMore(): boolean
  • Whether the cursor has any remaining batches that haven't yet been +fetched. If set to false, all batches have been fetched and no +additional requests to the server will be made when consuming any +remaining batches from this cursor.

    +

    Returns boolean

  • get hasNext(): boolean
  • Whether the cursor has more batches. If set to false, the cursor has +already been depleted and contains no more batches.

    +

    Returns boolean

Methods

  • Enables use with for await to deplete the cursor by asynchronously +yielding every batch in the cursor's remaining result set.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    Returns AsyncGenerator<T[], undefined, undefined>

    Example

    const cursor = await db.query(aql`
    FOR user IN users
    FILTER user.isActive
    RETURN user
    `);
    for await (const users of cursor.batches) {
    for (const user of users) {
    console.log(user.email, user.isAdmin);
    }
    } +
    +
  • Depletes the cursor, then returns an array containing all batches in the +cursor's remaining result list.

    +

    Returns Promise<T[][]>

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const result = await cursor.batches.all(); // [[1, 2], [3, 4], [5]]
    console.log(cursor.hasNext); // false +
    +
  • Depletes the cursor by applying the callback function to each batch in +the cursor's remaining result list. Returns an array containing the +return values of callback for each batch, flattened to a depth of 1.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.flatMap.

    +

    Type Parameters

    • R

      Return type of the callback function.

      +

    Parameters

    • callback: ((currentBatch, index, self) => R | R[])

      Function to execute on each element.

      +
        • (currentBatch, index, self): R | R[]
        • Parameters

          • currentBatch: T[]
          • index: number
          • self: this

          Returns R | R[]

    Returns Promise<R[]>

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const squares = await cursor.batches.flatMap((currentBatch) => {
    return currentBatch.map((value) => value ** 2);
    });
    console.log(squares); // [1, 1, 2, 4, 3, 9, 4, 16, 5, 25]
    console.log(cursor.hasNext); // false +
    +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 1 }
    );
    const odds = await cursor.batches.flatMap((currentBatch) => {
    if (currentBatch[0] % 2 === 0) {
    return []; // empty array flattens into nothing
    }
    return currentBatch;
    });
    console.logs(odds); // [1, 3, 5] +
    +
  • Advances the cursor by applying the callback function to each item in +the cursor's remaining result list until the cursor is depleted or +callback returns the exact value false. Returns a promise that +evalues to true unless the function returned false.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.forEach.

    +

    Parameters

    • callback: ((currentBatch, index, self) => false | void)

      Function to execute on each element.

      +
        • (currentBatch, index, self): false | void
        • Parameters

          • currentBatch: T[]
          • index: number
          • self: this

          Returns false | void

    Returns Promise<boolean>

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const result = await cursor.batches.forEach((currentBatch) => {
    for (const value of currentBatch) {
    console.log(value);
    }
    });
    console.log(result) // true
    console.log(cursor.hasNext); // false +
    +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const result = await cursor.batches.forEach((currentBatch) => {
    for (const value of currentBatch) {
    console.log(value);
    }
    return false; // stop after the first batch
    });
    console.log(result); // false
    console.log(cursor.hasNext); // true +
    +
  • Drains the cursor and frees up associated database resources.

    +

    This method has no effect if all batches have already been consumed.

    +

    Returns Promise<void>

    Example

    const cursor1 = await db.query(aql`FOR x IN 1..5 RETURN x`);
    console.log(cursor1.hasMore); // false
    await cursor1.kill(); // no effect

    const cursor2 = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    console.log(cursor2.hasMore); // true
    await cursor2.kill(); // cursor is depleted +
    +
  • Loads all remaining batches from the server.

    +

    Warning: This may impact memory use when working with very large +query result sets.

    +

    Returns Promise<void>

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 1 }
    );
    console.log(cursor.hasMore); // true
    await cursor.batches.loadAll();
    console.log(cursor.hasMore); // false
    console.log(cursor.hasNext); // true
    for await (const item of cursor) {
    console.log(item);
    // No server roundtrips necessary any more
    } +
    +
  • Depletes the cursor by applying the callback function to each batch in +the cursor's remaining result list. Returns an array containing the +return values of callback for each batch.

    +

    Note: This creates an array of all return values, which may impact +memory use when working with very large query result sets. Consider using +BatchedArrayCursor#forEach, BatchedArrayCursor#reduce or +BatchedArrayCursor#flatMap instead.

    +

    See also: +Array.prototype.map.

    +

    Type Parameters

    • R

      Return type of the callback function.

      +

    Parameters

    • callback: ((currentBatch, index, self) => R)

      Function to execute on each element.

      +
        • (currentBatch, index, self): R
        • Parameters

          • currentBatch: T[]
          • index: number
          • self: this

          Returns R

    Returns Promise<R[]>

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const squares = await cursor.batches.map((currentBatch) => {
    return currentBatch.map((value) => value ** 2);
    });
    console.log(squares); // [[1, 4], [9, 16], [25]]
    console.log(cursor.hasNext); // false +
    +
  • Advances the cursor and returns all remaining values in the cursor's +current batch. If the current batch has already been exhausted, fetches +the next batch from the server and returns it, or undefined if the +cursor has been depleted.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    Returns Promise<undefined | T[]>

    Example

    const cursor = await db.query(
    aql`FOR i IN 1..10 RETURN i`,
    { batchSize: 5 }
    );
    const firstBatch = await cursor.batches.next(); // [1, 2, 3, 4, 5]
    await cursor.next(); // 6
    const lastBatch = await cursor.batches.next(); // [7, 8, 9, 10]
    console.log(cursor.hasNext); // false +
    +
  • Depletes the cursor by applying the reducer function to each batch in +the cursor's remaining result list. Returns the return value of reducer +for the last batch.

    +

    Note: Most complex uses of the reduce method can be replaced with +simpler code using BatchedArrayCursor#forEach or the for await +syntax.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.reduce.

    +

    Type Parameters

    • R

      Return type of the reducer function.

      +

    Parameters

    • reducer: ((accumulator, currentBatch, index, self) => R)

      Function to execute on each element.

      +
        • (accumulator, currentBatch, index, self): R
        • Parameters

          • accumulator: R
          • currentBatch: T[]
          • index: number
          • self: this

          Returns R

    • initialValue: R

      Initial value of the accumulator value passed to +the reducer function.

      +

    Returns Promise<R>

    Example

    function largestValue(baseline, values) {
    return Math.max(baseline, ...values);
    }
    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 3 }
    );
    const result = await cursor.batches.reduce(largestValue, 0);
    console.log(result); // 5
    console.log(cursor.hasNext); // false
    const emptyResult = await cursor.batches.reduce(largestValue, 0);
    console.log(emptyResult); // 0 +
    +

    Example

    // BAD! NEEDLESSLY COMPLEX!
    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 1 }
    );
    const result = await cursor.reduce((accumulator, currentBatch) => {
    if (currentBatch[0] % 2 === 0) {
    accumulator.even.push(...currentBatch);
    } else {
    accumulator.odd.push(...currentBatch);
    }
    return accumulator;
    }, { odd: [], even: [] });
    console.log(result); // { odd: [1, 3, 5], even: [2, 4] }

    // GOOD! MUCH SIMPLER!
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const odd = [];
    const even = [];
    for await (const currentBatch of cursor) {
    if (currentBatch[0] % 2 === 0) {
    even.push(...currentBatch);
    } else {
    odd.push(...currentBatch);
    }
    }
    console.log({ odd, even }); // { odd: [1, 3, 5], even: [2, 4] } +
    +
  • Depletes the cursor by applying the reducer function to each batch in +the cursor's remaining result list. Returns the return value of reducer +for the last batch.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.reduce.

    +

    Type Parameters

    • R

      Return type of the reducer function.

      +

    Parameters

    • reducer: ((accumulator, currentBatch, index, self) => R)

      Function to execute on each element.

      +
        • (accumulator, currentBatch, index, self): R
        • Parameters

          • accumulator: T[] | R
          • currentBatch: T[]
          • index: number
          • self: this

          Returns R

    Returns Promise<undefined | R>

    Example

    function largestValue(values1, values2) {
    return [Math.max(...values1, ...values2)];
    }
    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 3 }
    );
    const result = await cursor.batches.reduce(largestValue);
    console.log(result); // [5]
    console.log(cursor.hasNext); // false +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/database.Database.html b/9.0.0-preview.1/classes/database.Database.html new file mode 100644 index 000000000..d1ece3ca5 --- /dev/null +++ b/9.0.0-preview.1/classes/database.Database.html @@ -0,0 +1,1237 @@ +Database | arangojs - v9.0.0-preview.1

An object representing a single ArangoDB database. All arangojs collections, +cursors, analyzers and so on are linked to a Database object.

+

Constructors

Accessors

Methods

acquireHostList +analyzer +analyzers +beginTransaction +clearSlowQueries +clearUserAccessLevel +close +collection +collections +commitLocalServiceState +computeClusterRebalance +createAnalyzer +createCollection +createDatabase +createEdgeCollection +createFunction +createGraph +createHotBackup +createJob +createUser +createView +database +databases +deleteAllJobResults +deleteExpiredJobResults +deleteHotBackup +downloadService +dropDatabase +dropFunction +executeClusterRebalance +executeTransaction +exists +explain +get +getClusterImbalance +getLogEntries +getLogLevel +getLogMessages +getService +getServiceConfiguration +getServiceDependencies +getServiceDocumentation +getServiceReadme +getUser +getUserAccessLevel +getUserDatabases +graph +graphs +installService +job +killQuery +listAnalyzers +listCollections +listCompletedJobs +listDatabases +listFunctions +listGraphs +listHotBackups +listPendingJobs +listRunningQueries +listServiceScripts +listServices +listSlowQueries +listTransactions +listUserDatabases +listUsers +listViews +login +parse +query +queryRules +queryTracking +rebalanceCluster +removeUser +renameCollection +renameView +renewAuthToken +replaceService +replaceServiceConfiguration +replaceServiceDependencies +replaceUser +restoreHotBackup +route +runServiceScript +runServiceTests +setLogLevel +setResponseQueueTimeSamples +setServiceDevelopmentMode +setUserAccessLevel +shutdown +time +transaction +transactions +uninstallService +updateServiceConfiguration +updateServiceDependencies +updateUser +upgradeService +useBasicAuth +useBearerAuth +userDatabases +version +view +views +waitForPropagation +withTransaction +

Constructors

  • Creates a new Database instance with its own connection pool.

    +

    See also Database#database.

    +

    Parameters

    • Optional config: Config

      An object with configuration options.

      +

    Returns Database

    Example

    const db = new Database({
    url: "http://127.0.0.1:8529",
    databaseName: "my_database",
    auth: { username: "admin", password: "hunter2" },
    }); +
    +
  • Creates a new Database instance with its own connection pool.

    +

    See also Database#database.

    +

    Parameters

    • url: string | string[]

      Base URL of the ArangoDB server or list of server URLs. +Equivalent to the url option in connection.Config.

      +
    • Optional name: string

    Returns Database

    Example

    const db = new Database("http://127.0.0.1:8529", "my_database");
    db.useBasicAuth("admin", "hunter2"); +
    +

Accessors

  • get name(): string
  • Name of the ArangoDB database this instance represents.

    +

    Returns string

Methods

  • Updates the URL list by requesting a list of all coordinators in the +cluster and adding any endpoints not initially specified in the +connection.Config.

    +

    For long-running processes communicating with an ArangoDB cluster it is +recommended to run this method periodically (e.g. once per hour) to make +sure new coordinators are picked up correctly and can be used for +fail-over or load balancing.

    +

    Parameters

    • overwrite: boolean = false

      If set to true, the existing host list will be +replaced instead of extended.

      +

    Returns Promise<void>

    Example

    const db = new Database();
    const interval = setInterval(
    () => db.acquireHostList(),
    5 * 60 * 1000 // every 5 minutes
    );

    // later
    clearInterval(interval);
    system.close(); +
    +
  • Returns an analyzer.Analyzer instance representing the Analyzer with the +given analyzerName.

    +

    Parameters

    • analyzerName: string

    Returns Analyzer

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    const info = await analyzer.get(); +
    +
  • Fetches all Analyzers visible in the database and returns an array of +analyzer.Analyzer instances for those Analyzers.

    +

    See also Database#listAnalyzers.

    +

    Returns Promise<Analyzer[]>

    Example

    const db = new Database();
    const analyzers = await db.analyzers();
    // analyzers is an array of Analyzer instances +
    +
  • Clears the list of recent slow queries.

    +

    See also Database#listSlowQueries.

    +

    Returns Promise<void>

    Example

    const db = new Database();
    await db.clearSlowQueries();
    // Slow query list is now cleared +
    +
  • Clears the given ArangoDB user's access level for the database, or the +given collection in the given database.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to clear the access level for.

      +
    • __namedParameters: UserAccessLevelOptions

    Returns Promise<ArangoApiResponse<Record<string, AccessLevel>>>

    Example

    const db = new Database();
    await db.clearUserAccessLevel("steve");
    // The access level of the user "steve" has been cleared for the current
    // database. +
    +

    Example

    const db = new Database();
    await db.clearUserAccessLevel("steve", { database: "staging" });
    // The access level of the user "steve" has been cleared for the "staging"
    // database. +
    +

    Example

    const db = new Database();
    await db.clearUserAccessLevel("steve", { collection: "pokemons" });
    // The access level of the user "steve" has been cleared for the
    // "pokemons" collection in the current database. +
    +

    Example

    const db = new Database();
    await db.clearUserAccessLevel("steve", {
    database: "staging",
    collection: "pokemons"
    });
    // The access level of the user "steve" has been cleared for the
    // "pokemons" collection in the "staging" database. +
    +

    Example

    const db = new Database();
    const staging = db.database("staging");
    await db.clearUserAccessLevel("steve", { database: staging });
    // The access level of the user "steve" has been cleared for the "staging"
    // database. +
    +

    Example

    const db = new Database();
    const staging = db.database("staging");
    await db.clearUserAccessLevel("steve", {
    collection: staging.collection("pokemons")
    });
    // The access level of the user "steve" has been cleared for the
    // "pokemons" collection in database "staging". +
    +
  • Closes all active connections of this database instance.

    +

    Can be used to clean up idling connections during longer periods of +inactivity.

    +

    Note: This method currently has no effect in the browser version of +arangojs.

    +

    Returns void

    Example

    const db = new Database();
    const sessions = db.collection("sessions");
    // Clean up expired sessions once per hour
    setInterval(async () => {
    await db.query(aql`
    FOR session IN ${sessions}
    FILTER session.expires < DATE_NOW()
    REMOVE session IN ${sessions}
    `);
    // Making sure to close the connections because they're no longer used
    system.close();
    }, 1000 * 60 * 60); +
    +
  • Returns a Collection instance for the given collection name.

    +

    In TypeScript the collection implements both the +collection.DocumentCollection and collection.EdgeCollection +interfaces and can be cast to either type to enforce a stricter API.

    +

    Type Parameters

    • T extends Record<string, any> = any

      Type to use for document data. Defaults to any.

      +

    Parameters

    • collectionName: string

      Name of the edge collection.

      +

    Returns DocumentCollection<T> & EdgeCollection<T>

    Example

    const db = new Database();
    const collection = db.collection("potatoes"); +
    +

    Example

    interface Person {
    name: string;
    }
    const db = new Database();
    const persons = db.collection<Person>("persons"); +
    +

    Example

    interface Person {
    name: string;
    }
    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const documents = db.collection("persons") as DocumentCollection<Person>;
    const edges = db.collection("friends") as EdgeCollection<Friend>; +
    +
  • Fetches all collections from the database and returns an array of +Collection instances.

    +

    In TypeScript these instances implement both the +collection.DocumentCollection and collection.EdgeCollection +interfaces and can be cast to either type to enforce a stricter API.

    +

    See also Database#listCollections.

    +

    Parameters

    • excludeSystem: boolean = true

      Whether system collections should be excluded.

      +

    Returns Promise<(DocumentCollection<any> & EdgeCollection<any>)[]>

    Example

    const db = new Database();
    const collections = await db.collections();
    // collections is an array of DocumentCollection and EdgeCollection
    // instances not including system collections +
    +

    Example

    const db = new Database();
    const collections = await db.collections(false);
    // collections is an array of DocumentCollection and EdgeCollection
    // instances including system collections +
    +
  • Writes all locally available services to the database and updates any +service bundles missing in the database.

    +

    Parameters

    • replace: boolean = false

      If set to true, outdated services will also be +committed. This can be used to solve some consistency problems when +service bundles are missing in the database or were deleted manually.

      +

    Returns Promise<void>

    Example

    await db.commitLocalServiceState();
    // all services available on the coordinator have been written to the db +
    +

    Example

    await db.commitLocalServiceState(true);
    // all service conflicts have been resolved in favor of this coordinator +
    +
  • Computes a set of move shard operations to rebalance the cluster.

    +

    Parameters

    Returns Promise<ClusterRebalanceResult>

    Example

    const db = new Database();
    const result = await db.computerClusterRebalance({
    moveLeaders: true,
    moveFollowers: true
    });
    if (result.moves.length) {
    await db.executeClusterRebalance(result.moves);
    } +
    +
  • Creates a new Analyzer with the given analyzerName and options, then +returns an analyzer.Analyzer instance for the new Analyzer.

    +

    Parameters

    • analyzerName: string

      Name of the Analyzer.

      +
    • options: CreateAnalyzerOptions

      An object defining the properties of the Analyzer.

      +

    Returns Promise<Analyzer>

    Example

    const db = new Database();
    const analyzer = await db.createAnalyzer("potatoes", { type: "identity" });
    // the identity Analyzer "potatoes" now exists +
    +
  • Creates a new collection with the given collectionName and options, +then returns a collection.DocumentCollection instance for the new collection.

    +

    Type Parameters

    • T extends Record<string, any> = any

      Type to use for document data. Defaults to any.

      +

    Parameters

    Returns Promise<DocumentCollection<T>>

    Example

    const db = new Database();
    const documents = db.createCollection("persons"); +
    +

    Example

    interface Person {
    name: string;
    }
    const db = new Database();
    const documents = db.createCollection<Person>("persons"); +
    +
  • Creates a new edge collection with the given collectionName and +options, then returns an collection.EdgeCollection instance for the new +edge collection.

    +

    Type Parameters

    • T extends Record<string, any> = any

      Type to use for edge document data. Defaults to any.

      +

    Parameters

    Returns Promise<EdgeCollection<T>>

    Example

    const db = new Database();
    const edges = db.createCollection("friends", {
    type: CollectionType.EDGE_COLLECTION
    }); +
    +

    Example

    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const edges = db.createCollection<Friend>("friends", {
    type: CollectionType.EDGE_COLLECTION
    }); +
    +
  • Creates a new database with the given databaseName with the given +options and returns a Database instance for that database.

    +

    Parameters

    • databaseName: string

      Name of the database to create.

      +
    • Optional options: CreateDatabaseOptions

      Options for creating the database.

      +

    Returns Promise<Database>

    Example

    const db = new Database();
    const info = await db.createDatabase("mydb", {
    users: [{ username: "root" }]
    });
    // the database has been created +
    +
  • Creates a new database with the given databaseName with the given +users and returns a Database instance for that database.

    +

    Parameters

    • databaseName: string

      Name of the database to create.

      +
    • users: CreateDatabaseUser[]

      Database users to create with the database.

      +

    Returns Promise<Database>

    Example

    const db = new Database();
    const info = await db.createDatabase("mydb", [{ username: "root" }]);
    // the database has been created +
    +
  • Creates a new edge collection with the given collectionName and +options, then returns an collection.EdgeCollection instance for the new +edge collection.

    +

    This is a convenience method for calling Database#createCollection +with options.type set to EDGE_COLLECTION.

    +

    Type Parameters

    • T extends Record<string, any> = any

      Type to use for edge document data. Defaults to any.

      +

    Parameters

    • collectionName: string

      Name of the new collection.

      +
    • Optional options: CreateCollectionOptions

      Options for creating the collection.

      +

    Returns Promise<EdgeCollection<T>>

    Example

    const db = new Database();
    const edges = db.createEdgeCollection("friends"); +
    +

    Example

    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const edges = db.createEdgeCollection<Friend>("friends"); +
    +
  • Creates an AQL user function with the given name and code if it does +not already exist or replaces it if a function with the same name already +existed.

    +

    Parameters

    • name: string

      A valid AQL function name. The function name must consist +of at least two alphanumeric identifiers separated with double colons.

      +
    • code: string

      A string evaluating to a JavaScript function (not a +JavaScript function object).

      +
    • isDeterministic: boolean = false

      If set to true, the function is expected to +always return the same result for equivalent inputs. This option currently +has no effect but may allow for optimizations in the future.

      +

    Returns Promise<ArangoApiResponse<{
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    await db.createFunction(
    "ACME::ACCOUNTING::CALCULATE_VAT",
    "(price) => price * 0.19"
    );
    // Use the new function in an AQL query with template handler:
    const cursor = await db.query(aql`
    FOR product IN products
    RETURN MERGE(
    { vat: ACME::ACCOUNTING::CALCULATE_VAT(product.price) },
    product
    )
    `);
    // cursor is a cursor for the query result +
    +
  • Creates a graph with the given graphName and edgeDefinitions, then +returns a graph.Graph instance for the new graph.

    +

    Parameters

    • graphName: string

      Name of the graph to be created.

      +
    • edgeDefinitions: EdgeDefinitionOptions[]

      An array of edge definitions.

      +
    • Optional options: CreateGraphOptions

      An object defining the properties of the graph.

      +

    Returns Promise<Graph>

  • (Enterprise Edition only.) Creates a hot backup of the entire ArangoDB +deployment including all databases, collections, etc.

    +

    Returns an object describing the backup result.

    +

    Parameters

    Returns Promise<HotBackupResult>

    Example

    const info = await db.createHotBackup();
    // a hot backup has been created +
    +
  • Creates an async job by executing the given callback function. The first +database request performed by the callback will be marked for asynchronous +execution and its result will be made available as an async job.

    +

    Returns a Job instance that can be used to retrieve the result +of the callback function once the request has been executed.

    +

    Type Parameters

    • T

    Parameters

    • callback: (() => Promise<T>)

      Callback function to execute as an async job.

      +
        • (): Promise<T>
        • Returns Promise<T>

    Returns Promise<Job<T>>

    Example

    const db = new Database();
    const job = await db.createJob(() => db.collections());
    while (!job.isLoaded) {
    await timeout(1000);
    await job.load();
    }
    // job.result is a list of Collection instances +
    +
  • Creates a new ArangoDB user with the given password.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to create.

      +
    • passwd: string

      Password of the new ArangoDB user.

      +

    Returns Promise<ArangoApiResponse<ArangoUser>>

    Example

    const db = new Database();
    const user = await db.createUser("steve", "hunter2");
    // The user "steve" has been created +
    +
  • Creates a new ArangoDB user with the given options.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to create.

      +
    • options: UserOptions

      Additional options for creating the ArangoDB user.

      +

    Returns Promise<ArangoApiResponse<ArangoUser>>

    Example

    const db = new Database();
    const user = await db.createUser("steve", { passwd: "hunter2" });
    // The user "steve" has been created +
    +
  • Creates a new View with the given viewName and options, then returns a +view.View instance for the new View.

    +

    Parameters

    • viewName: string

      Name of the View.

      +
    • options: CreateViewOptions

      An object defining the properties of the View.

      +

    Returns Promise<View>

    Example

    const db = new Database();
    const view = await db.createView("potatoes", { type: "arangosearch" });
    // the ArangoSearch View "potatoes" now exists +
    +
  • Creates a new Database instance for the given databaseName that +shares this database's connection pool.

    +

    See also :constructor.

    +

    Parameters

    • databaseName: string

      Name of the database.

      +

    Returns Database

    Example

    const systemDb = new Database();
    const myDb = system.database("my_database"); +
    +
  • Deletes the results of all completed async jobs.

    +

    Returns Promise<void>

  • Deletes the results of all completed async jobs created before the given +threshold.

    +

    Parameters

    • threshold: number

      The expiration timestamp in milliseconds.

      +

    Returns Promise<void>

    Example

    const db = new Database();
    const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
    await db.deleteExpiredJobResults(Date.now() - ONE_WEEK);
    // all job results older than a week have been deleted +
    +
  • (Enterprise Edition only.) Deletes a local hot backup.

    +

    Parameters

    • id: string

      The ID of the backup to delete.

      +

    Returns Promise<void>

    Example

    await db.deleteHotBackup("2023-09-19T15.38.21Z_example");
    // the backup has been deleted +
    +
  • Retrieves a zip bundle containing the service files.

    +

    Returns a Buffer in node.js or Blob in the browser.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +

    Returns Promise<Buffer | Blob>

    Example

    const db = new Database();
    const serviceBundle = await db.downloadService("/my-foxx"); +
    +
  • Deletes the database with the given databaseName from the server.

    +

    Parameters

    • databaseName: string

      Name of the database to delete.

      +

    Returns Promise<boolean>

    Example

    const db = new Database();
    await db.dropDatabase("mydb");
    // database "mydb" no longer exists +
    +
  • Deletes the AQL user function with the given name from the database.

    +

    Parameters

    • name: string

      The name of the user function to drop.

      +
    • group: boolean = false

      If set to true, all functions with a name starting with +name will be deleted, otherwise only the function with the exact name +will be deleted.

      +

    Returns Promise<ArangoApiResponse<{
        deletedCount: number;
    }>>

    Example

    const db = new Database();
    await db.dropFunction("ACME::ACCOUNTING::CALCULATE_VAT");
    // the function no longer exists +
    +
  • Executes the given cluster move shard operations.

    +

    Parameters

    Returns Promise<unknown>

    Example

    const db = new Database();
    const result = await db.computerClusterRebalance({
    moveLeaders: true,
    moveFollowers: true
    });
    if (result.moves.length) {
    await db.executeClusterRebalance(result.moves);
    } +
    +
  • Performs a server-side JavaScript transaction and returns its return +value.

    +

    Collections can be specified as collection names (strings) or objects +implementing the collection.ArangoCollection interface: Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.

    +

    Note: The action function will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any values other than those passed via the params option.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +

    Parameters

    • collections: TransactionCollections & {
          allowImplicit?: boolean;
      }

      Collections involved in the transaction.

      +
    • action: string

      A string evaluating to a JavaScript function to be +executed on the server.

      +
    • Optional options: TransactionOptions & {
          params?: any;
      }

      Options for the transaction. If options.allowImplicit +is specified, it will be used if collections.allowImplicit was not +specified.

      +

    Returns Promise<any>

    Example

    const db = new Database();

    const action = `
    function(params) {
    // This code will be executed inside ArangoDB!
    const { query } = require("@arangodb");
    return query\`
    FOR user IN _users
    FILTER user.age > ${params.age}
    RETURN u.user
    \`.toArray();
    }
    `);

    const result = await db.executeTransaction({
    read: ["_users"]
    }, action, {
    params: { age: 12 }
    });
    // result contains the return value of the action +
    +
  • Performs a server-side transaction and returns its return value.

    +

    Collections can be specified as collection names (strings) or objects +implementing the collection.ArangoCollection interface: Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.

    +

    Note: The action function will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any values other than those passed via the params option. +See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +

    Parameters

    • collections: (string | ArangoCollection)[]

      Collections that can be read from and written to +during the transaction.

      +
    • action: string

      A string evaluating to a JavaScript function to be +executed on the server.

      +
    • Optional options: TransactionOptions & {
          params?: any;
      }

      Options for the transaction.

      +

    Returns Promise<any>

    Example

    const db = new Database();

    const action = `
    function(params) {
    // This code will be executed inside ArangoDB!
    const { query } = require("@arangodb");
    return query\`
    FOR user IN _users
    FILTER user.age > ${params.age}
    RETURN u.user
    \`.toArray();
    }
    `);

    const result = await db.executeTransaction(["_users"], action, {
    params: { age: 12 }
    });
    // result contains the return value of the action +
    +
  • Performs a server-side transaction and returns its return value.

    +

    The Collection can be specified as a collection name (string) or an object +implementing the collection.ArangoCollection interface: Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.

    +

    Note: The action function will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any values other than those passed via the params option. +See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +

    Parameters

    • collection: string | ArangoCollection

      A collection that can be read from and written to +during the transaction.

      +
    • action: string

      A string evaluating to a JavaScript function to be +executed on the server.

      +
    • Optional options: TransactionOptions & {
          params?: any;
      }

      Options for the transaction.

      +

    Returns Promise<any>

    Example

    const db = new Database();

    const action = `
    function(params) {
    // This code will be executed inside ArangoDB!
    const { query } = require("@arangodb");
    return query\`
    FOR user IN _users
    FILTER user.age > ${params.age}
    RETURN u.user
    \`.toArray();
    }
    `);

    const result = await db.executeTransaction("_users", action, {
    params: { age: 12 }
    });
    // result contains the return value of the action +
    +
  • Checks whether the database exists.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const result = await db.exists();
    // result indicates whether the database exists +
    +
  • Explains a database query using the given query.

    +

    See the aql!aql template string handler for information about how +to create a query string without manually defining bind parameters nor +having to worry about escaping variables.

    +

    Parameters

    • query: AqlQuery<any>

      An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql!aql template string.

      +
    • Optional options: ExplainOptions & {
          allPlans?: false;
      }

      Options for explaining the query.

      +

    Returns Promise<ArangoApiResponse<SingleExplainResult>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const explanation = await db.explain(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `); +
    +
  • Explains a database query using the given query.

    +

    See the aql!aql template string handler for information about how +to create a query string without manually defining bind parameters nor +having to worry about escaping variables.

    +

    Parameters

    • query: AqlQuery<any>

      An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql!aql template string.

      +
    • Optional options: ExplainOptions & {
          allPlans: true;
      }

      Options for explaining the query.

      +

    Returns Promise<ArangoApiResponse<MultiExplainResult>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const explanation = await db.explain(
    aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `,
    { allPlans: true }
    ); +
    +
  • Explains a database query using the given query and bindVars.

    +

    See the aql!aql template string handler for a safer and easier +alternative to passing strings directly.

    +

    Parameters

    • query: string | AqlLiteral

      An AQL query string.

      +
    • Optional bindVars: Record<string, any>

      An object defining bind parameters for the query.

      +
    • Optional options: ExplainOptions & {
          allPlans?: false;
      }

      Options for explaining the query.

      +

    Returns Promise<ArangoApiResponse<SingleExplainResult>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const explanation = await db.explain(
    `
    FOR doc IN @@collection
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `,
    { "@collection": collection.name }
    ); +
    +
  • Explains a database query using the given query and bindVars.

    +

    See the aql!aql template string handler for a safer and easier +alternative to passing strings directly.

    +

    Parameters

    • query: string | AqlLiteral

      An AQL query string.

      +
    • Optional bindVars: Record<string, any>

      An object defining bind parameters for the query.

      +
    • Optional options: ExplainOptions & {
          allPlans: true;
      }

      Options for explaining the query.

      +

    Returns Promise<ArangoApiResponse<MultiExplainResult>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const explanation = await db.explain(
    `
    FOR doc IN @@collection
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `,
    { "@collection": collection.name },
    { allPlans: true }
    ); +
    +
  • Fetches the database description for the active database from the server.

    +

    Returns Promise<DatabaseInfo>

    Example

    const db = new Database();
    const info = await db.get();
    // the database exists +
    +
  • Retrieves the log messages from the server's global log.

    +

    Parameters

    Returns Promise<LogEntries>

    Example

    const log = await db.getLogEntries();
    for (let i = 0; i < log.totalAmount; i++) {
    console.log(`${
    new Date(log.timestamp[i] * 1000).toISOString()
    } - [${LogLevel[log.level[i]]}] ${log.text[i]} (#${log.lid[i]})`);
    } +
    +
  • Retrieves the server's current log level for each topic.

    +

    Returns Promise<Record<string, LogLevelSetting>>

    Example

    const levels = await db.getLogLevel();
    console.log(levels.request); // log level for incoming requests +
    +
  • Retrieves the log messages from the server's global log.

    +

    Parameters

    Returns Promise<LogMessage[]>

    Deprecated

    This endpoint has been deprecated in ArangoDB 3.8. +Use Database#getLogEntries instead.

    +

    Example

    const messages = await db.getLogMessages();
    for (const m of messages) {
    console.log(`${m.date} - [${m.level}] ${m.message} (#${m.id})`);
    } +
    +
  • Retrieves information about a mounted service.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +

    Returns Promise<ServiceInfo>

    Example

    const db = new Database();
    const info = await db.getService("/my-service");
    // info contains detailed information about the service +
    +
  • Retrieves information about the service's configuration options and their +current values.

    +

    See also Database#replaceServiceConfiguration and +Database#updateServiceConfiguration.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • Optional minimal: false

      If set to true, the result will only include each +configuration option's current value. Otherwise it will include the full +definition for each option.

      +

    Returns Promise<Record<string, ServiceConfiguration>>

    Example

    const db = new Database();
    const config = await db.getServiceConfiguration("/my-service");
    for (const [key, option] of Object.entries(config)) {
    console.log(`${option.title} (${key}): ${option.current}`);
    } +
    +
  • Retrieves information about the service's configuration options and their +current values.

    +

    See also Database#replaceServiceConfiguration and +Database#updateServiceConfiguration.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • minimal: true

      If set to true, the result will only include each +configuration option's current value. Otherwise it will include the full +definition for each option.

      +

    Returns Promise<Record<string, any>>

    Example

    const db = new Database();
    const config = await db.getServiceConfiguration("/my-service", true);
    for (const [key, value] of Object.entries(config)) {
    console.log(`${key}: ${value}`);
    } +
    +
  • Retrieves information about the service's dependencies and their current +mount points.

    +

    See also Database#replaceServiceDependencies and +Database#updateServiceDependencies.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • Optional minimal: false

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +

    Returns Promise<Record<string, SingleServiceDependency | MultiServiceDependency>>

    Example

    const db = new Database();
    const deps = await db.getServiceDependencies("/my-service");
    for (const [key, dep] of Object.entries(deps)) {
    console.log(`${dep.title} (${key}): ${dep.current}`);
    } +
    +
  • Retrieves information about the service's dependencies and their current +mount points.

    +

    See also Database#replaceServiceDependencies and +Database#updateServiceDependencies.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • minimal: true

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +

    Returns Promise<Record<string, string | string[]>>

    Example

    const db = new Database();
    const deps = await db.getServiceDependencies("/my-service", true);
    for (const [key, value] of Object.entries(deps)) {
    console.log(`${key}: ${value}`);
    } +
    +
  • Retrieves an Open API compatible Swagger API description object for the +service installed at the given mount point.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +

    Returns Promise<SwaggerJson>

    Example

    const db = new Database();
    const spec = await db.getServiceDocumentation("/my-service");
    // spec is a Swagger API description of the service +
    +
  • Retrieves the text content of the service's README or README.md file.

    +

    Returns undefined if no such file could be found.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +

    Returns Promise<undefined | string>

    Example

    const db = new Database();
    const readme = await db.getServiceReadme("/my-service");
    if (readme !== undefined) console.log(readme);
    else console.warn(`No README found.`) +
    +
  • Fetches the user data of a single ArangoDB user.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to fetch.

      +

    Returns Promise<ArangoApiResponse<ArangoUser>>

    Example

    const db = new Database();
    const user = await db.getUser("steve");
    // user is the user object for the user named "steve" +
    +
  • Fetches the given ArangoDB user's access level for the database, or the +given collection in the given database.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to fetch the access level for.

      +
    • __namedParameters: UserAccessLevelOptions

    Returns Promise<AccessLevel>

    Example

    const db = new Database();
    const accessLevel = await db.getUserAccessLevel("steve");
    // The access level of the user "steve" has been fetched for the current
    // database. +
    +

    Example

    const db = new Database();
    const accessLevel = await db.getUserAccessLevel("steve", {
    database: "staging"
    });
    // The access level of the user "steve" has been fetched for the "staging"
    // database. +
    +

    Example

    const db = new Database();
    const accessLevel = await db.getUserAccessLevel("steve", {
    collection: "pokemons"
    });
    // The access level of the user "steve" has been fetched for the
    // "pokemons" collection in the current database. +
    +

    Example

    const db = new Database();
    const accessLevel = await db.getUserAccessLevel("steve", {
    database: "staging",
    collection: "pokemons"
    });
    // The access level of the user "steve" has been fetched for the
    // "pokemons" collection in the "staging" database. +
    +

    Example

    const db = new Database();
    const staging = db.database("staging");
    const accessLevel = await db.getUserAccessLevel("steve", {
    database: staging
    });
    // The access level of the user "steve" has been fetched for the "staging"
    // database. +
    +

    Example

    const db = new Database();
    const staging = db.database("staging");
    const accessLevel = await db.getUserAccessLevel("steve", {
    collection: staging.collection("pokemons")
    });
    // The access level of the user "steve" has been fetched for the
    // "pokemons" collection in database "staging". +
    +
  • Fetches an object mapping names of databases to the access level of the +given ArangoDB user for those databases.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to fetch the access levels for.

      +
    • Optional full: false

      Whether access levels for collections should be included.

      +

    Returns Promise<Record<string, AccessLevel>>

    Example

    const db = new Database();
    const accessLevels = await db.getUserDatabases("steve");
    for (const [databaseName, accessLevel] of Object.entries(accessLevels)) {
    console.log(`${databaseName}: ${accessLevel}`);
    } +
    +
  • Fetches an object mapping names of databases to the access level of the +given ArangoDB user for those databases and the collections within each +database.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to fetch the access levels for.

      +
    • full: true

      Whether access levels for collections should be included.

      +

    Returns Promise<Record<string, {
        collections: Record<string, "undefined" | AccessLevel>;
        permission: AccessLevel;
    }>>

    Example

    const db = new Database();
    const accessLevels = await db.getUserDatabases("steve", true);
    for (const [databaseName, obj] of Object.entries(accessLevels)) {
    console.log(`${databaseName}: ${obj.permission}`);
    for (const [collectionName, accessLevel] of Object.entries(obj.collections)) {
    console.log(`${databaseName}/${collectionName}: ${accessLevel}`);
    }
    } +
    +
  • Returns a graph.Graph instance representing the graph with the given +graphName.

    +

    Parameters

    • graphName: string

      Name of the graph.

      +

    Returns Graph

    Example

    const db = new Database();
    const graph = db.graph("some-graph"); +
    +
  • Fetches all graphs from the database and returns an array of graph.Graph +instances for those graphs.

    +

    See also Database#listGraphs.

    +

    Returns Promise<Graph[]>

    Example

    const db = new Database();
    const graphs = await db.graphs();
    // graphs is an array of Graph instances +
    +
  • Installs a new service.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • source: string | Blob | File

      The service bundle to install.

      +
    • options: InstallServiceOptions = {}

      Options for installing the service.

      +

    Returns Promise<ServiceInfo>

    Example

    const db = new Database();
    // Using a Buffer in Node.js as source
    const source = new Blob([await fs.readFileSync("./my-foxx-service.zip")]);
    const info = await db.installService("/hello", source); +
    +

    Example

    const db = new Database();
    // Using a Blob in Node.js as source
    const source = await fs.openAsBlob("./my-foxx-service.zip");
    const info = await db.installService("/hello", source); +
    +

    Example

    const db = new Database();
    // Using a File from a browser file input as source
    const element = document.getElementById("my-file-input");
    const source = element.files[0];
    const info = await db.installService("/hello", source); +
    +
  • Returns a job.Job instance for the given jobId.

    +

    Parameters

    • jobId: string

      ID of the async job.

      +

    Returns Job<any>

    Example

    const db = new Database();
    const job = db.job("12345"); +
    +
  • Kills a running query with the given queryId.

    +

    See also Database#listRunningQueries.

    +

    Parameters

    • queryId: string

      The ID of a currently running query.

      +

    Returns Promise<void>

    Example

    const db = new Database();
    const queries = await db.listRunningQueries();
    await Promise.all(queries.map(
    async (query) => {
    if (query.state === "executing") {
    await db.killQuery(query.id);
    }
    }
    )); +
    +
  • Fetches all Analyzers visible in the database and returns an array of +Analyzer descriptions.

    +

    See also Database#analyzers.

    +

    Returns Promise<AnalyzerDescription[]>

    Example

    const db = new Database();
    const analyzers = await db.listAnalyzers();
    // analyzers is an array of Analyzer descriptions +
    +
  • Fetches all collections from the database and returns an array of +collection descriptions.

    +

    See also Database#collections.

    +

    Parameters

    • excludeSystem: boolean = true

      Whether system collections should be excluded.

      +

    Returns Promise<CollectionMetadata[]>

    Example

    const db = new Database();
    const collections = await db.listCollections();
    // collections is an array of collection descriptions
    // not including system collections +
    +

    Example

    const db = new Database();
    const collections = await db.listCollections(false);
    // collections is an array of collection descriptions
    // including system collections +
    +
  • Returns a list of the IDs of all currently available completed async jobs.

    +

    Returns Promise<string[]>

    Example

    const db = new Database();
    const completedJobs = await db.listCompletedJobs();
    console.log(completedJobs); // e.g. ["12345", "67890"] +
    +
  • Fetches all databases from the server and returns an array of their names.

    +

    See also Database#databases and +Database#listUserDatabases.

    +

    Returns Promise<string[]>

    Example

    const db = new Database();
    const names = await db.listDatabases();
    // databases is an array of database names +
    +
  • Fetches a list of all AQL user functions registered with the database.

    +

    Returns Promise<AqlUserFunction[]>

    Example

    const db = new Database();
    const functions = await db.listFunctions();
    const names = functions.map(fn => fn.name); +
    +
  • Fetches all graphs from the database and returns an array of graph +descriptions.

    +

    See also Database#graphs.

    +

    Returns Promise<GraphInfo[]>

    Example

    const db = new Database();
    const graphs = await db.listGraphs();
    // graphs is an array of graph descriptions +
    +
  • (Enterprise Edition only.) Retrieves a list of all locally found hot +backups.

    +

    Parameters

    • Optional id: string | string[]

      If specified, only the backup with the given ID will be +returned.

      +

    Returns Promise<HotBackupList>

    Example

    const backups = await db.listHotBackups();
    for (const backup of backups) {
    console.log(backup.id);
    } +
    +
  • Returns a list of the IDs of all currently pending async jobs.

    +

    Returns Promise<string[]>

    Example

    const db = new Database();
    const pendingJobs = await db.listPendingJobs();
    console.log(pendingJobs); // e.g. ["12345", "67890"] +
    +
  • Retrieves a list of scripts defined in the service manifest's "scripts" +section mapped to their human readable representations.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +

    Returns Promise<Record<string, string>>

    Example

    const db = new Database();
    const scripts = await db.listServiceScripts("/my-service");
    for (const [name, title] of Object.entries(scripts)) {
    console.log(`${name}: ${title}`);
    } +
    +
  • Fetches a list of all installed service.

    +

    Parameters

    • excludeSystem: boolean = true

      Whether system services should be excluded.

      +

    Returns Promise<ServiceSummary[]>

    Example

    const db = new Database();
    const services = await db.listServices(); +
    +

    Example

    const db = new Database();
    const services = await db.listServices(false); // all services +
    +
  • Fetches all active transactions from the database and returns an array of +transaction descriptions.

    +

    See also Database#transactions.

    +

    Returns Promise<TransactionDetails[]>

    Example

    const db = new Database();
    const transactions = await db.listTransactions();
    // transactions is an array of transaction descriptions +
    +
  • Fetches all databases accessible to the active user from the server and +returns an array of their names.

    +

    See also Database#userDatabases and +Database#listDatabases.

    +

    Returns Promise<string[]>

    Example

    const db = new Database();
    const names = await db.listUserDatabases();
    // databases is an array of database names +
    +
  • Fetches all ArangoDB users visible to the authenticated user and returns +an array of user objects.

    +

    Returns Promise<ArangoUser[]>

    Example

    const db = new Database();
    const users = await db.listUsers();
    // users is an array of user objects +
    +
  • Fetches all Views from the database and returns an array of View +descriptions.

    +

    See also Database#views.

    +

    Returns Promise<ViewDescription[]>

    Example

    const db = new Database();

    const views = await db.listViews();
    // views is an array of View descriptions +
    +
  • Validates the given database credentials and exchanges them for an +authentication token, then uses the authentication token for future +requests and returns it.

    +

    Parameters

    • username: string = "root"

      The username to authenticate with.

      +
    • password: string = ""

      The password to authenticate with.

      +

    Returns Promise<string>

    Example

    const db = new Database();
    await db.login("admin", "hunter2");
    // with an authentication token for the "admin" user. +
    +
  • Parses the given query and returns the result.

    +

    See the aql!aql template string handler for information about how +to create a query string without manually defining bind parameters nor +having to worry about escaping variables.

    +

    Parameters

    • query: string | AqlLiteral | AqlQuery<any>

      An AQL query string or an object containing an AQL query +string and bind parameters, e.g. the object returned from an aql!aql +template string.

      +

    Returns Promise<ParseResult>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const ast = await db.parse(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `); +
    +
  • Performs a database query using the given query, then returns a new +cursor.ArrayCursor instance for the result set.

    +

    See the aql!aql template string handler for information about how +to create a query string without manually defining bind parameters nor +having to worry about escaping variables.

    +

    Note: When executing a query in a streaming transaction using the +step method, the resulting cursor will be bound to that transaction and +you do not need to use the step method to consume it.

    +

    Type Parameters

    • T = any

    Parameters

    • query: AqlQuery<T>

      An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql!aql template string.

      +
    • Optional options: QueryOptions

      Options for the query execution.

      +

    Returns Promise<ArrayCursor<T>>

    Example

    const db = new Database();
    const active = true;
    const Users = db.collection("_users");

    // Using an aql template string:
    // Bind parameters are automatically extracted and arangojs collections
    // are automatically passed as collection bind parameters.
    const cursor = await db.query(aql`
    FOR u IN ${Users}
    FILTER u.authData.active == ${active}
    RETURN u.user
    `);
    // cursor is a cursor for the query result +
    +

    Example

    const db = new Database();
    const active = true;
    const Users = db.collection("_users");

    // Using an object with a regular multi-line string
    const cursor = await db.query({
    query: `
    FOR u IN @@users
    FILTER u.authData.active == @active
    RETURN u.user
    `,
    bindVars: { active: active, "@users": Users.name }
    }); +
    +
  • Performs a database query using the given query and bindVars, then +returns a new cursor.ArrayCursor instance for the result set.

    +

    See the aql!aql template string handler for a safer and easier +alternative to passing strings directly.

    +

    Note: When executing a query in a streaming transaction using the +step method, the resulting cursor will be bound to that transaction and +you do not need to use the step method to consume it.

    +

    Type Parameters

    • T = any

    Parameters

    • query: string | AqlLiteral

      An AQL query string.

      +
    • Optional bindVars: Record<string, any>

      An object defining bind parameters for the query.

      +
    • Optional options: QueryOptions

      Options for the query execution.

      +

    Returns Promise<ArrayCursor<T>>

    Example

    const db = new Database();
    const active = true;
    const Users = db.collection("_users");

    const cursor = await db.query(
    // A normal multi-line string
    `
    FOR u IN @@users
    FILTER u.authData.active == @active
    RETURN u.user
    `,
    { active: active, "@users": Users.name }
    ); +
    +

    Example

    const db = new Database();
    const active = true;
    const Users = db.collection("_users");

    const cursor = await db.query(
    // An AQL literal created from a normal multi-line string
    aql.literal(`
    FOR u IN @@users
    FILTER u.authData.active == @active
    RETURN u.user
    `),
    { active: active, "@users": Users.name }
    ); +
    +
  • Fetches the available optimizer rules.

    +

    Returns Promise<QueryOptimizerRule[]>

    Example

    const db = new Database();
    const rules = await db.queryRules();
    for (const rule of rules) {
    console.log(rule.name);
    } +
    +
  • Fetches the query tracking properties.

    +

    Returns Promise<QueryTracking>

    Example

    const db = new Database();
    const tracking = await db.queryTracking();
    console.log(tracking.enabled); +
    +
  • Modifies the query tracking properties.

    +

    Parameters

    Returns Promise<QueryTracking>

    Example

    const db = new Database();
    // track up to 5 slow queries exceeding 5 seconds execution time
    await db.setQueryTracking({
    enabled: true,
    trackSlowQueries: true,
    maxSlowQueries: 5,
    slowQueryThreshold: 5
    }); +
    +
  • Removes the ArangoDB user with the given username from the server.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to remove.

      +

    Returns Promise<ArangoApiResponse<Record<string, never>>>

    Example

    const db = new Database();
    await db.removeUser("steve");
    // The user "steve" has been removed +
    +
  • Renames the collection collectionName to newName.

    +

    Additionally removes any stored Collection instance for +collectionName from the Database instance's internal cache.

    +

    Note: Renaming collections may not be supported when ArangoDB is +running in a cluster configuration.

    +

    Parameters

    • collectionName: string

      Current name of the collection.

      +
    • newName: string

      The new name of the collection.

      +

    Returns Promise<ArangoApiResponse<CollectionMetadata>>

  • Renames the view viewName to newName.

    +

    Additionally removes any stored view.View instance for viewName from +the Database instance's internal cache.

    +

    Note: Renaming views may not be supported when ArangoDB is running in +a cluster configuration.

    +

    Parameters

    • viewName: string

      Current name of the view.

      +
    • newName: string

      The new name of the view.

      +

    Returns Promise<ArangoApiResponse<ViewDescription>>

  • Attempts to renew the authentication token passed to Database#useBearerAuth +or returned and used by Database#login. If a new authentication +token is issued, it will be used for future requests and returned.

    +

    Returns Promise<null | string>

    Example

    const db = new Database();
    await db.login("admin", "hunter2");
    // ... later ...
    const newToken = await db.renewAuthToken();
    if (!newToken) // no new token issued +
    +
  • Replaces an existing service with a new service by completely removing the +old service and installing a new service at the same mount point.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • source: string | Blob | File

      The service bundle to install.

      +
    • options: ReplaceServiceOptions = {}

      Options for replacing the service.

      +

    Returns Promise<ServiceInfo>

    Example

    const db = new Database();
    // Using a Buffer in Node.js as source
    const source = new Blob([await fs.readFileSync("./my-foxx-service.zip")]);
    const info = await db.replaceService("/hello", source); +
    +

    Example

    const db = new Database();
    // Using a Blob in Node.js as source
    const source = await fs.openAsBlob("./my-foxx-service.zip");
    const info = await db.replaceService("/hello", source); +
    +

    Example

    const db = new Database();
    // Using a File from a browser file input as source
    const element = document.getElementById("my-file-input");
    const source = element.files[0];
    const info = await db.replaceService("/hello", source); +
    +
  • Replaces the configuration of the given service, discarding any existing +values for options not specified.

    +

    See also Database#updateServiceConfiguration and +Database#getServiceConfiguration.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • cfg: Record<string, any>

      An object mapping configuration option names to values.

      +
    • Optional minimal: false

      If set to true, the result will only include each +configuration option's current value and warning (if any). +Otherwise it will include the full definition for each option.

      +

    Returns Promise<Record<string, ServiceConfiguration & {
        warning?: string;
    }>>

    Example

    const db = new Database();
    const config = { currency: "USD", locale: "en-US" };
    const info = await db.replaceServiceConfiguration("/my-service", config);
    for (const [key, option] of Object.entries(info)) {
    console.log(`${option.title} (${key}): ${option.value}`);
    if (option.warning) console.warn(`Warning: ${option.warning}`);
    } +
    +
  • Replaces the configuration of the given service, discarding any existing +values for options not specified.

    +

    See also Database#updateServiceConfiguration and +Database#getServiceConfiguration.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • cfg: Record<string, any>

      An object mapping configuration option names to values.

      +
    • minimal: true

      If set to true, the result will only include each +configuration option's current value and warning (if any). +Otherwise it will include the full definition for each option.

      +

    Returns Promise<{
        values: Record<string, any>;
        warnings: Record<string, string>;
    }>

    Example

    const db = new Database();
    const config = { currency: "USD", locale: "en-US" };
    const info = await db.replaceServiceConfiguration("/my-service", config);
    for (const [key, value] of Object.entries(info.values)) {
    console.log(`${key}: ${value}`);
    if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
    } +
    +
  • Replaces the dependencies of the given service, discarding any existing +mount points for dependencies not specified.

    +

    See also Database#updateServiceDependencies and +Database#getServiceDependencies.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • deps: Record<string, string>
    • Optional minimal: false

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +

    Returns Promise<Record<string, (SingleServiceDependency | MultiServiceDependency) & {
        warning?: string;
    }>>

    Example

    const db = new Database();
    const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
    const info = await db.replaceServiceDependencies("/my-service", deps);
    for (const [key, dep] of Object.entries(info)) {
    console.log(`${dep.title} (${key}): ${dep.current}`);
    if (dep.warning) console.warn(`Warning: ${dep.warning}`);
    } +
    +
  • Replaces the dependencies of the given service, discarding any existing +mount points for dependencies not specified.

    +

    See also Database#updateServiceDependencies and +Database#getServiceDependencies.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • deps: Record<string, string>
    • minimal: true

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +

    Returns Promise<{
        values: Record<string, string>;
        warnings: Record<string, string>;
    }>

    Example

    const db = new Database();
    const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
    const info = await db.replaceServiceDependencies(
    "/my-service",
    deps,
    true
    );
    for (const [key, value] of Object.entries(info)) {
    console.log(`${key}: ${value}`);
    if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
    } +
    +
  • Replaces the ArangoDB user's option with the new options.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to modify.

      +
    • options: UserOptions

      New options to replace the user's existing options.

      +

    Returns Promise<ArangoApiResponse<ArangoUser>>

    Example

    const db = new Database();
    const user = await db.replaceUser("steve", { passwd: "", active: false });
    // The user "steve" has been set to inactive with an empty password +
    +
  • (Enteprise Edition only.) Restores a consistent local hot backup.

    +

    Returns the directory path of the restored backup.

    +

    Parameters

    • id: string

      The ID of the backup to restore.

      +

    Returns Promise<string>

    Example

    await db.restoreHotBackup("2023-09-19T15.38.21Z_example");
    // the backup has been restored +
    +
  • Returns a new route.Route instance for the given path (relative to the +database) that can be used to perform arbitrary HTTP requests.

    +

    Parameters

    • Optional path: string

      The database-relative URL of the route. Defaults to the +database API root.

      +
    • Optional headers: Headers | Record<string, string>

      Default headers that should be sent with each request to +the route.

      +

    Returns Route

    Example

    const db = new Database();
    const myFoxxService = db.route("my-foxx-service");
    const response = await myFoxxService.post("users", {
    username: "admin",
    password: "hunter2"
    });
    // response.body is the result of
    // POST /_db/_system/my-foxx-service/users
    // with JSON request body '{"username": "admin", "password": "hunter2"}' +
    +
  • Executes a service script and retrieves its result exposed as +module.exports (if any).

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • name: string

      Name of the service script to execute as defined in the +service manifest.

      +
    • Optional params: any

      Arbitrary value that will be exposed to the script as +argv[0] in the service context (e.g. module.context.argv[0]). +Must be serializable to JSON.

      +

    Returns Promise<any>

    Example

    const db = new Database();
    const result = await db.runServiceScript(
    "/my-service",
    "create-user",
    {
    username: "service_admin",
    password: "hunter2"
    }
    ); +
    +
  • Runs the tests of a given service and returns the results using the +"default" reporter.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • Optional options: {
          filter?: string;
          idiomatic?: false;
          reporter?: "default";
      }

      Options for running the tests.

      +
      • Optional filter?: string

        If set, only tests with full names including this exact string will be +executed.

        +
      • Optional idiomatic?: false

        Whether the reporter should use "idiomatic" mode. Has no effect when +using the "default" or "suite" reporters.

        +
      • Optional reporter?: "default"

    Returns Promise<ServiceTestDefaultReport>

    Example

    const db = new Database();
    const testReport = await db.runServiceTests("/my-foxx"); +
    +
  • Runs the tests of a given service and returns the results using the +"suite" reporter, which groups the test result by test suite.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • options: {
          filter?: string;
          idiomatic?: false;
          reporter: "suite";
      }

      Options for running the tests.

      +
      • Optional filter?: string

        If set, only tests with full names including this exact string will be +executed.

        +
      • Optional idiomatic?: false

        Whether the reporter should use "idiomatic" mode. Has no effect when +using the "default" or "suite" reporters.

        +
      • reporter: "suite"

    Returns Promise<ServiceTestSuiteReport>

    Example

    const db = new Database();
    const suiteReport = await db.runServiceTests(
    "/my-foxx",
    { reporter: "suite" }
    ); +
    +
  • Runs the tests of a given service and returns the results using the +"stream" reporter, which represents the results as a sequence of tuples +representing events.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • options: {
          filter?: string;
          idiomatic?: false;
          reporter: "stream";
      }

      Options for running the tests.

      +
      • Optional filter?: string

        If set, only tests with full names including this exact string will be +executed.

        +
      • Optional idiomatic?: false

        Whether the reporter should use "idiomatic" mode. If set to true, +the results will be returned as a formatted string.

        +
      • reporter: "stream"

    Returns Promise<ServiceTestStreamReport>

    Example

    const db = new Database();
    const streamEvents = await db.runServiceTests(
    "/my-foxx",
    { reporter: "stream" }
    ); +
    +
  • Runs the tests of a given service and returns the results using the +"tap" reporter, which represents the results as an array of strings using +the "tap" format.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • options: {
          filter?: string;
          idiomatic?: false;
          reporter: "tap";
      }

      Options for running the tests.

      +
      • Optional filter?: string

        If set, only tests with full names including this exact string will be +executed.

        +
      • Optional idiomatic?: false

        Whether the reporter should use "idiomatic" mode. If set to true, +the results will be returned as a formatted string.

        +
      • reporter: "tap"

    Returns Promise<ServiceTestTapReport>

    Example

    const db = new Database();
    const tapLines = await db.runServiceTests(
    "/my-foxx",
    { reporter: "tap" }
    ); +
    +
  • Runs the tests of a given service and returns the results using the +"xunit" reporter, which represents the results as an XML document using +the JSONML exchange format.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • options: {
          filter?: string;
          idiomatic?: false;
          reporter: "xunit";
      }

      Options for running the tests.

      +
      • Optional filter?: string

        If set, only tests with full names including this exact string will be +executed.

        +
      • Optional idiomatic?: false

        Whether the reporter should use "idiomatic" mode. If set to true, +the results will be returned as a formatted string.

        +
      • reporter: "xunit"

    Returns Promise<ServiceTestXunitReport>

    Example

    const db = new Database();
    const jsonML = await db.runServiceTests(
    "/my-foxx",
    { reporter: "xunit" }
    ); +
    +
  • Runs the tests of a given service and returns the results as a string +using the "stream" reporter in "idiomatic" mode, which represents the +results as a line-delimited JSON stream of tuples representing events.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • options: {
          filter?: string;
          idiomatic: true;
          reporter: "stream";
      }

      Options for running the tests.

      +
      • Optional filter?: string

        If set, only tests with full names including this exact string will be +executed.

        +
      • idiomatic: true

        Whether the reporter should use "idiomatic" mode. If set to false, +the results will be returned as an array of tuples instead of a +string.

        +
      • reporter: "stream"

    Returns Promise<string>

    Example

    const db = new Database();
    const streamReport = await db.runServiceTests(
    "/my-foxx",
    { reporter: "stream", idiomatic: true }
    ); +
    +
  • Runs the tests of a given service and returns the results as a string +using the "tap" reporter in "idiomatic" mode, which represents the +results using the "tap" format.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • options: {
          filter?: string;
          idiomatic: true;
          reporter: "tap";
      }

      Options for running the tests.

      +
      • Optional filter?: string

        If set, only tests with full names including this exact string will be +executed.

        +
      • idiomatic: true

        Whether the reporter should use "idiomatic" mode. If set to false, +the results will be returned as an array of strings instead of a +single string.

        +
      • reporter: "tap"

    Returns Promise<string>

    Example

    const db = new Database();
    const tapReport = await db.runServiceTests(
    "/my-foxx",
    { reporter: "tap", idiomatic: true }
    ); +
    +
  • Runs the tests of a given service and returns the results as a string +using the "xunit" reporter in "idiomatic" mode, which represents the +results as an XML document.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • options: {
          filter?: string;
          idiomatic: true;
          reporter: "xunit";
      }

      Options for running the tests.

      +
      • Optional filter?: string

        If set, only tests with full names including this exact string will be +executed.

        +
      • idiomatic: true

        Whether the reporter should use "idiomatic" mode. If set to false, +the results will be returned using the JSONML exchange format +instead of a string.

        +
      • reporter: "xunit"

    Returns Promise<string>

    Example

    const db = new Database();
    const xml = await db.runServiceTests(
    "/my-foxx",
    { reporter: "xunit", idiomatic: true }
    ); +
    +
  • Sets the server's log level for each of the given topics to the given level.

    +

    Any omitted topics will be left unchanged.

    +

    Parameters

    • levels: Record<string, LogLevelSetting>

      An object mapping topic names to log levels.

      +

    Returns Promise<Record<string, LogLevelSetting>>

    Example

    await db.setLogLevel({ request: "debug" });
    // Debug information will now be logged for each request +
    +
  • Sets the limit for the number of values of the most recently received +server-reported queue times that can be accessed using +Database#queueTime.

    +

    Parameters

    • responseQueueTimeSamples: number

      Number of values to maintain.

      +

    Returns void

  • Enables or disables development mode for the given service.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • enabled: boolean = true

      Whether development mode should be enabled or disabled.

      +

    Returns Promise<ServiceInfo>

    Example

    const db = new Database();
    await db.setServiceDevelopmentMode("/my-service", true);
    // the service is now in development mode
    await db.setServiceDevelopmentMode("/my-service", false);
    // the service is now in production mode +
    +
  • Sets the given ArangoDB user's access level for the database, or the +given collection in the given database.

    +

    Parameters

    Returns Promise<ArangoApiResponse<Record<string, AccessLevel>>>

    Example

    const db = new Database();
    await db.setUserAccessLevel("steve", { grant: "rw" });
    // The user "steve" now has read-write access to the current database. +
    +

    Example

    const db = new Database();
    await db.setUserAccessLevel("steve", {
    database: "staging",
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "staging" database. +
    +

    Example

    const db = new Database();
    await db.setUserAccessLevel("steve", {
    collection: "pokemons",
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "pokemons" collection
    // in the current database. +
    +

    Example

    const db = new Database();
    await db.setUserAccessLevel("steve", {
    database: "staging",
    collection: "pokemons",
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "pokemons" collection
    // in the "staging" database. +
    +

    Example

    const db = new Database();
    const staging = db.database("staging");
    await db.setUserAccessLevel("steve", {
    database: staging,
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "staging" database. +
    +

    Example

    const db = new Database();
    const staging = db.database("staging");
    await db.setUserAccessLevel("steve", {
    collection: staging.collection("pokemons"),
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "pokemons" collection
    // in database "staging". +
    +
  • Attempts to initiate a clean shutdown of the server.

    +

    Returns Promise<void>

  • Retrives the server's current system time in milliseconds with microsecond +precision.

    +

    Returns Promise<number>

  • Completely removes a service from the database.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • Optional options: UninstallServiceOptions

      Options for uninstalling the service.

      +

    Returns Promise<void>

    Example

    const db = new Database();
    await db.uninstallService("/my-foxx"); +
    +
  • Updates the configuration of the given service while maintaining any +existing values for options not specified.

    +

    See also Database#replaceServiceConfiguration and +Database#getServiceConfiguration.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • cfg: Record<string, any>

      An object mapping configuration option names to values.

      +
    • Optional minimal: false

      If set to true, the result will only include each +configuration option's current value and warning (if any). +Otherwise it will include the full definition for each option.

      +

    Returns Promise<Record<string, ServiceConfiguration & {
        warning?: string;
    }>>

    Example

    const db = new Database();
    const config = { currency: "USD", locale: "en-US" };
    const info = await db.updateServiceConfiguration("/my-service", config);
    for (const [key, option] of Object.entries(info)) {
    console.log(`${option.title} (${key}): ${option.value}`);
    if (option.warning) console.warn(`Warning: ${option.warning}`);
    } +
    +
  • Updates the configuration of the given service while maintaining any +existing values for options not specified.

    +

    See also Database#replaceServiceConfiguration and +Database#getServiceConfiguration.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • cfg: Record<string, any>

      An object mapping configuration option names to values.

      +
    • minimal: true

      If set to true, the result will only include each +configuration option's current value and warning (if any). +Otherwise it will include the full definition for each option.

      +

    Returns Promise<{
        values: Record<string, any>;
        warnings: Record<string, string>;
    }>

    Example

    const db = new Database();
    const config = { currency: "USD", locale: "en-US" };
    const info = await db.updateServiceConfiguration("/my-service", config);
    for (const [key, value] of Object.entries(info.values)) {
    console.log(`${key}: ${value}`);
    if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
    } +
    +
  • Updates the dependencies of the given service while maintaining any +existing mount points for dependencies not specified.

    +

    See also Database#replaceServiceDependencies and +Database#getServiceDependencies.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • deps: Record<string, string>
    • Optional minimal: false

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +

    Returns Promise<Record<string, (SingleServiceDependency | MultiServiceDependency) & {
        warning?: string;
    }>>

    Example

    const db = new Database();
    const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
    const info = await db.updateServiceDependencies("/my-service", deps);
    for (const [key, dep] of Object.entries(info)) {
    console.log(`${dep.title} (${key}): ${dep.current}`);
    if (dep.warning) console.warn(`Warning: ${dep.warning}`);
    } +
    +
  • Updates the dependencies of the given service while maintaining any +existing mount points for dependencies not specified.

    +

    See also Database#replaceServiceDependencies and +Database#getServiceDependencies.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • deps: Record<string, string>
    • minimal: true

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +

    Returns Promise<{
        values: Record<string, string>;
        warnings: Record<string, string>;
    }>

    Example

    const db = new Database();
    const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
    const info = await db.updateServiceDependencies(
    "/my-service",
    deps,
    true
    );
    for (const [key, value] of Object.entries(info)) {
    console.log(`${key}: ${value}`);
    if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
    } +
    +
  • Sets the password of a given ArangoDB user to the new value.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to change the password for.

      +
    • passwd: string

      New password for the ArangoDB user.

      +

    Returns Promise<ArangoApiResponse<ArangoUser>>

    Example

    const db = new Database();
    const user = await db.updateUser("steve", "hunter2");
    // The user "steve" has received a new password +
    +
  • Updates the ArangoDB user with the new options.

    +

    Parameters

    • username: string

      Name of the ArangoDB user to modify.

      +
    • options: Partial<UserOptions>

      Options of the ArangoDB user to modify.

      +

    Returns Promise<ArangoApiResponse<ArangoUser>>

    Example

    const db = new Database();
    const user = await db.updateUser("steve", { active: false });
    // The user "steve" has been set to inactive +
    +
  • Replaces an existing service with a new service while retaining the old +service's configuration and dependencies.

    +

    Parameters

    • mount: string

      The service's mount point, relative to the database.

      +
    • source: string | Blob | File

      The service bundle to install.

      +
    • options: UpgradeServiceOptions = {}

      Options for upgrading the service.

      +

    Returns Promise<ServiceInfo>

    Example

    const db = new Database();
    // Using a Buffer in Node.js as source
    const source = new Blob([await fs.readFileSync("./my-foxx-service.zip")]);
    const info = await db.upgradeService("/hello", source); +
    +

    Example

    const db = new Database();
    // Using a Blob in Node.js as source
    const source = await fs.openAsBlob("./my-foxx-service.zip");
    const info = await db.upgradeService("/hello", source); +
    +

    Example

    const db = new Database();
    // Using a File from a browser file input as source
    const element = document.getElementById("my-file-input");
    const source = element.files[0];
    const info = await db.upgradeService("/hello", source); +
    +
  • Updates the underlying connection's authorization header to use Basic +authentication with the given username and password, then returns +itself.

    +

    Parameters

    • username: string = "root"

      The username to authenticate with.

      +
    • password: string = ""

      The password to authenticate with.

      +

    Returns this

    Example

    const db = new Database();
    db.useBasicAuth("admin", "hunter2");
    // with the username "admin" and password "hunter2". +
    +
  • Updates the underlying connection's authorization header to use Bearer +authentication with the given authentication token, then returns itself.

    +

    Parameters

    • token: string

      The token to authenticate with.

      +

    Returns this

    Example

    const db = new Database();
    db.useBearerAuth("keyboardcat");
    // The database instance now uses Bearer authentication. +
    +
  • Fetches all databases accessible to the active user from the server and +returns an array of Database instances for those databases.

    +

    See also Database#listUserDatabases and +Database#databases.

    +

    Returns Promise<Database[]>

    Example

    const db = new Database();
    const names = await db.userDatabases();
    // databases is an array of databases +
    +
  • Fetches version information from the ArangoDB server.

    +

    Parameters

    • Optional details: boolean

      If set to true, additional information about the +ArangoDB server will be available as the details property.

      +

    Returns Promise<VersionInfo>

    Example

    const db = new Database();
    const version = await db.version();
    // the version object contains the ArangoDB version information.
    // license: "community" or "enterprise"
    // version: ArangoDB version number
    // server: description of the server +
    +
  • Returns a view.View instance for the given viewName.

    +

    Parameters

    • viewName: string

      Name of the ArangoSearch or SearchAlias View.

      +

    Returns View

    Example

    const db = new Database();
    const view = db.view("potatoes"); +
    +
  • Fetches all Views from the database and returns an array of +view.View instances +for the Views.

    +

    See also Database#listViews.

    +

    Returns Promise<View[]>

    Example

    const db = new Database();
    const views = await db.views();
    // views is an array of ArangoSearch View instances +
    +
  • Performs a request against every known coordinator and returns when the +request has succeeded against every coordinator or the timeout is reached.

    +

    Note: This method is primarily intended to make database setup easier +in cluster scenarios and requires all coordinators to be known to arangojs +before the method is invoked. The method is not useful in single-server or +leader-follower replication scenarios.

    +

    Parameters

    • request: RequestOptions

      Request to perform against each known coordinator.

      +
    • Optional timeout: number

      Maximum number of milliseconds to wait for propagation.

      +

    Returns Promise<void>

    Example

    const db = new Database({ loadBalancingStrategy: "ROUND_ROBIN" });
    await system.acquireHostList();
    const analyzer = db.analyzer("my-analyzer");
    await analyzer.create();
    await db.waitForPropagation(
    { path: `/_api/analyzer/${encodeURIComponent(analyzer.name)}` },
    30000
    );
    // Analyzer has been propagated to all coordinators and can safely be used +
    +
  • Begins and commits a transaction using the given callback. Individual +requests that are part of the transaction need to be wrapped in the step +function passed into the callback. If the promise returned by the callback +is rejected, the transaction will be aborted.

    +

    Collections can be specified as collection names (strings) or objects +implementing the collection.ArangoCollection interface: Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as +well as (in TypeScript) collection.DocumentCollection and +collection.EdgeCollection.

    +

    Type Parameters

    • T

    Parameters

    • collections: TransactionCollections

      Collections involved in the transaction.

      +
    • callback: ((step) => Promise<T>)

      Callback function executing the transaction steps.

      +
        • (step): Promise<T>
        • Parameters

          • step: (<T>(callback) => Promise<T>)
              • <T>(callback): Promise<T>
              • Executes the given function locally as a single step of the transaction.

                +

                Type Parameters

                • T

                  Type of the callback's returned promise.

                  +

                Parameters

                • callback: (() => Promise<T>)

                  Callback function returning a promise.

                  +

                  Warning: The callback function should wrap a single call of an async +arangojs method (e.g. a method on a Collection object of a collection +that is involved in the transaction or the db.query method). +If the callback function is async, only the first promise-returning (or +async) method call will be executed as part of the transaction. See the +examples below for how to avoid common mistakes when using this method.

                  +

                  Note: Avoid defining the callback as an async function if possible +as arangojs will throw an error if the callback did not return a promise. +Async functions will return an empty promise by default, making it harder +to notice if you forgot to return something from the callback.

                  +

                  Note: Although almost anything can be wrapped in a callback and passed +to this method, that does not guarantee ArangoDB can actually do it in a +transaction. Refer to the ArangoDB documentation if you are unsure whether +a given operation can be executed as part of a transaction. Generally any +modification or retrieval of data is eligible but modifications of +collections or databases are not.

                  +
                    • (): Promise<T>
                    • Returns Promise<T>

                Returns Promise<T>

                Example

                const db = new Database();
                const vertices = db.collection("vertices");
                const edges = db.collection("edges");
                const trx = await db.beginTransaction({ write: [vertices, edges] });

                // The following code will be part of the transaction
                const left = await trx.step(() => vertices.save({ label: "left" }));
                const right = await trx.step(() => vertices.save({ label: "right" }));

                // Results from preceding actions can be used normally
                await trx.step(() => edges.save({
                _from: left._id,
                _to: right._id,
                data: "potato"
                }));

                // Transaction must be committed for changes to take effected
                // Always call either trx.commit or trx.abort to end a transaction
                await trx.commit(); +
                +

                Example

                // BAD! If the callback is an async function it must only use await once!
                await trx.step(async () => {
                await collection.save(data);
                await collection.save(moreData); // WRONG
                });

                // BAD! Callback function must use only one arangojs call!
                await trx.step(() => {
                return collection.save(data)
                .then(() => collection.save(moreData)); // WRONG
                });

                // BETTER: Wrap every arangojs method call that should be part of the
                // transaction in a separate `trx.step` call
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData)); +
                +

                Example

                // BAD! If the callback is an async function it must not await before
                // calling an arangojs method!
                await trx.step(async () => {
                await doSomethingElse();
                return collection.save(data); // WRONG
                });

                // BAD! Any arangojs inside the callback must not happen inside a promise
                // method!
                await trx.step(() => {
                return doSomethingElse()
                .then(() => collection.save(data)); // WRONG
                });

                // BETTER: Perform any async logic needed outside the `trx.step` call
                await doSomethingElse();
                await trx.step(() => collection.save(data));

                // OKAY: You can perform async logic in the callback after the arangojs
                // method call as long as it does not involve additional arangojs method
                // calls, but this makes it easy to make mistakes later
                await trx.step(async () => {
                await collection.save(data);
                await doSomethingDifferent(); // no arangojs method calls allowed
                }); +
                +

                Example

                // BAD! The callback should not use any functions that themselves use any
                // arangojs methods!
                async function saveSomeData() {
                await collection.save(data);
                await collection.save(moreData);
                }
                await trx.step(() => saveSomeData()); // WRONG

                // BETTER: Pass the transaction to functions that need to call arangojs
                // methods inside a transaction
                async function saveSomeData(trx) {
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));
                }
                await saveSomeData(); // no `trx.step` call needed +
                +

                Example

                // BAD! You must wait for the promise to resolve (or await on the
                // `trx.step` call) before calling `trx.step` again!
                trx.step(() => collection.save(data)); // WRONG
                await trx.step(() => collection.save(moreData));

                // BAD! The trx.step callback can not make multiple calls to async arangojs
                // methods, not even using Promise.all!
                await trx.step(() => Promise.all([ // WRONG
                collection.save(data),
                collection.save(moreData),
                ]));

                // BAD! Multiple `trx.step` calls can not run in parallel!
                await Promise.all([ // WRONG
                trx.step(() => collection.save(data)),
                trx.step(() => collection.save(moreData)),
                ]));

                // BETTER: Always call `trx.step` sequentially, one after the other
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));

                // OKAY: The then callback can be used if async/await is not available
                trx.step(() => collection.save(data))
                .then(() => trx.step(() => collection.save(moreData))); +
                +

                Example

                // BAD! The callback will return an empty promise that resolves before
                // the inner arangojs method call has even talked to ArangoDB!
                await trx.step(async () => {
                collection.save(data); // WRONG
                });

                // BETTER: Use an arrow function so you don't forget to return
                await trx.step(() => collection.save(data));

                // OKAY: Remember to always return when using a function body
                await trx.step(() => {
                return collection.save(data); // easy to forget!
                });

                // OKAY: You do not have to use arrow functions but it helps
                await trx.step(function () {
                return collection.save(data);
                }); +
                +

                Example

                // BAD! You can not pass promises instead of a callback!
                await trx.step(collection.save(data)); // WRONG

                // BETTER: Wrap the code in a function and pass the function instead
                await trx.step(() => collection.save(data)); +
                +

                Example

                // WORSE: Calls to non-async arangojs methods don't need to be performed
                // as part of a transaction
                const collection = await trx.step(() => db.collection("my-documents"));

                // BETTER: If an arangojs method is not async and doesn't return promises,
                // call it without `trx.step`
                const collection = db.collection("my-documents"); +
                +

          Returns Promise<T>

    • Optional options: TransactionOptions

      Options for the transaction.

      +

    Returns Promise<T>

    Example

    const vertices = db.collection("vertices");
    const edges = db.collection("edges");
    await db.withTransaction(
    {
    read: ["vertices"],
    write: [edges] // collection instances can be passed directly
    },
    async (step) => {
    const start = await step(() => vertices.document("a"));
    const end = await step(() => vertices.document("b"));
    await step(() => edges.save({ _from: start._id, _to: end._id }));
    }
    ); +
    +
  • Begins and commits a transaction using the given callback. Individual +requests that are part of the transaction need to be wrapped in the step +function passed into the callback. If the promise returned by the callback +is rejected, the transaction will be aborted.

    +

    Collections can be specified as collection names (strings) or objects +implementing the collection.ArangoCollection interface: Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.

    +

    Type Parameters

    • T

    Parameters

    • collections: (string | ArangoCollection)[]

      Collections that can be read from and written to +during the transaction.

      +
    • callback: ((step) => Promise<T>)

      Callback function executing the transaction steps.

      +
        • (step): Promise<T>
        • Parameters

          • step: (<T>(callback) => Promise<T>)
              • <T>(callback): Promise<T>
              • Executes the given function locally as a single step of the transaction.

                +

                Type Parameters

                • T

                  Type of the callback's returned promise.

                  +

                Parameters

                • callback: (() => Promise<T>)

                  Callback function returning a promise.

                  +

                  Warning: The callback function should wrap a single call of an async +arangojs method (e.g. a method on a Collection object of a collection +that is involved in the transaction or the db.query method). +If the callback function is async, only the first promise-returning (or +async) method call will be executed as part of the transaction. See the +examples below for how to avoid common mistakes when using this method.

                  +

                  Note: Avoid defining the callback as an async function if possible +as arangojs will throw an error if the callback did not return a promise. +Async functions will return an empty promise by default, making it harder +to notice if you forgot to return something from the callback.

                  +

                  Note: Although almost anything can be wrapped in a callback and passed +to this method, that does not guarantee ArangoDB can actually do it in a +transaction. Refer to the ArangoDB documentation if you are unsure whether +a given operation can be executed as part of a transaction. Generally any +modification or retrieval of data is eligible but modifications of +collections or databases are not.

                  +
                    • (): Promise<T>
                    • Returns Promise<T>

                Returns Promise<T>

                Example

                const db = new Database();
                const vertices = db.collection("vertices");
                const edges = db.collection("edges");
                const trx = await db.beginTransaction({ write: [vertices, edges] });

                // The following code will be part of the transaction
                const left = await trx.step(() => vertices.save({ label: "left" }));
                const right = await trx.step(() => vertices.save({ label: "right" }));

                // Results from preceding actions can be used normally
                await trx.step(() => edges.save({
                _from: left._id,
                _to: right._id,
                data: "potato"
                }));

                // Transaction must be committed for changes to take effected
                // Always call either trx.commit or trx.abort to end a transaction
                await trx.commit(); +
                +

                Example

                // BAD! If the callback is an async function it must only use await once!
                await trx.step(async () => {
                await collection.save(data);
                await collection.save(moreData); // WRONG
                });

                // BAD! Callback function must use only one arangojs call!
                await trx.step(() => {
                return collection.save(data)
                .then(() => collection.save(moreData)); // WRONG
                });

                // BETTER: Wrap every arangojs method call that should be part of the
                // transaction in a separate `trx.step` call
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData)); +
                +

                Example

                // BAD! If the callback is an async function it must not await before
                // calling an arangojs method!
                await trx.step(async () => {
                await doSomethingElse();
                return collection.save(data); // WRONG
                });

                // BAD! Any arangojs inside the callback must not happen inside a promise
                // method!
                await trx.step(() => {
                return doSomethingElse()
                .then(() => collection.save(data)); // WRONG
                });

                // BETTER: Perform any async logic needed outside the `trx.step` call
                await doSomethingElse();
                await trx.step(() => collection.save(data));

                // OKAY: You can perform async logic in the callback after the arangojs
                // method call as long as it does not involve additional arangojs method
                // calls, but this makes it easy to make mistakes later
                await trx.step(async () => {
                await collection.save(data);
                await doSomethingDifferent(); // no arangojs method calls allowed
                }); +
                +

                Example

                // BAD! The callback should not use any functions that themselves use any
                // arangojs methods!
                async function saveSomeData() {
                await collection.save(data);
                await collection.save(moreData);
                }
                await trx.step(() => saveSomeData()); // WRONG

                // BETTER: Pass the transaction to functions that need to call arangojs
                // methods inside a transaction
                async function saveSomeData(trx) {
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));
                }
                await saveSomeData(); // no `trx.step` call needed +
                +

                Example

                // BAD! You must wait for the promise to resolve (or await on the
                // `trx.step` call) before calling `trx.step` again!
                trx.step(() => collection.save(data)); // WRONG
                await trx.step(() => collection.save(moreData));

                // BAD! The trx.step callback can not make multiple calls to async arangojs
                // methods, not even using Promise.all!
                await trx.step(() => Promise.all([ // WRONG
                collection.save(data),
                collection.save(moreData),
                ]));

                // BAD! Multiple `trx.step` calls can not run in parallel!
                await Promise.all([ // WRONG
                trx.step(() => collection.save(data)),
                trx.step(() => collection.save(moreData)),
                ]));

                // BETTER: Always call `trx.step` sequentially, one after the other
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));

                // OKAY: The then callback can be used if async/await is not available
                trx.step(() => collection.save(data))
                .then(() => trx.step(() => collection.save(moreData))); +
                +

                Example

                // BAD! The callback will return an empty promise that resolves before
                // the inner arangojs method call has even talked to ArangoDB!
                await trx.step(async () => {
                collection.save(data); // WRONG
                });

                // BETTER: Use an arrow function so you don't forget to return
                await trx.step(() => collection.save(data));

                // OKAY: Remember to always return when using a function body
                await trx.step(() => {
                return collection.save(data); // easy to forget!
                });

                // OKAY: You do not have to use arrow functions but it helps
                await trx.step(function () {
                return collection.save(data);
                }); +
                +

                Example

                // BAD! You can not pass promises instead of a callback!
                await trx.step(collection.save(data)); // WRONG

                // BETTER: Wrap the code in a function and pass the function instead
                await trx.step(() => collection.save(data)); +
                +

                Example

                // WORSE: Calls to non-async arangojs methods don't need to be performed
                // as part of a transaction
                const collection = await trx.step(() => db.collection("my-documents"));

                // BETTER: If an arangojs method is not async and doesn't return promises,
                // call it without `trx.step`
                const collection = db.collection("my-documents"); +
                +

          Returns Promise<T>

    • Optional options: TransactionOptions

      Options for the transaction.

      +

    Returns Promise<T>

    Example

    const vertices = db.collection("vertices");
    const edges = db.collection("edges");
    await db.withTransaction(
    [
    "vertices",
    edges, // collection instances can be passed directly
    ],
    async (step) => {
    const start = await step(() => vertices.document("a"));
    const end = await step(() => vertices.document("b"));
    await step(() => edges.save({ _from: start._id, _to: end._id }));
    }
    ); +
    +
  • Begins and commits a transaction using the given callback. Individual +requests that are part of the transaction need to be wrapped in the step +function passed into the callback. If the promise returned by the callback +is rejected, the transaction will be aborted.

    +

    The Collection can be specified as a collection name (string) or an object +implementing the collection.ArangoCollection interface: Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.

    +

    Type Parameters

    • T

    Parameters

    • collection: string | ArangoCollection

      A collection that can be read from and written to +during the transaction.

      +
    • callback: ((step) => Promise<T>)

      Callback function executing the transaction steps.

      +
        • (step): Promise<T>
        • Parameters

          • step: (<T>(callback) => Promise<T>)
              • <T>(callback): Promise<T>
              • Executes the given function locally as a single step of the transaction.

                +

                Type Parameters

                • T

                  Type of the callback's returned promise.

                  +

                Parameters

                • callback: (() => Promise<T>)

                  Callback function returning a promise.

                  +

                  Warning: The callback function should wrap a single call of an async +arangojs method (e.g. a method on a Collection object of a collection +that is involved in the transaction or the db.query method). +If the callback function is async, only the first promise-returning (or +async) method call will be executed as part of the transaction. See the +examples below for how to avoid common mistakes when using this method.

                  +

                  Note: Avoid defining the callback as an async function if possible +as arangojs will throw an error if the callback did not return a promise. +Async functions will return an empty promise by default, making it harder +to notice if you forgot to return something from the callback.

                  +

                  Note: Although almost anything can be wrapped in a callback and passed +to this method, that does not guarantee ArangoDB can actually do it in a +transaction. Refer to the ArangoDB documentation if you are unsure whether +a given operation can be executed as part of a transaction. Generally any +modification or retrieval of data is eligible but modifications of +collections or databases are not.

                  +
                    • (): Promise<T>
                    • Returns Promise<T>

                Returns Promise<T>

                Example

                const db = new Database();
                const vertices = db.collection("vertices");
                const edges = db.collection("edges");
                const trx = await db.beginTransaction({ write: [vertices, edges] });

                // The following code will be part of the transaction
                const left = await trx.step(() => vertices.save({ label: "left" }));
                const right = await trx.step(() => vertices.save({ label: "right" }));

                // Results from preceding actions can be used normally
                await trx.step(() => edges.save({
                _from: left._id,
                _to: right._id,
                data: "potato"
                }));

                // Transaction must be committed for changes to take effected
                // Always call either trx.commit or trx.abort to end a transaction
                await trx.commit(); +
                +

                Example

                // BAD! If the callback is an async function it must only use await once!
                await trx.step(async () => {
                await collection.save(data);
                await collection.save(moreData); // WRONG
                });

                // BAD! Callback function must use only one arangojs call!
                await trx.step(() => {
                return collection.save(data)
                .then(() => collection.save(moreData)); // WRONG
                });

                // BETTER: Wrap every arangojs method call that should be part of the
                // transaction in a separate `trx.step` call
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData)); +
                +

                Example

                // BAD! If the callback is an async function it must not await before
                // calling an arangojs method!
                await trx.step(async () => {
                await doSomethingElse();
                return collection.save(data); // WRONG
                });

                // BAD! Any arangojs inside the callback must not happen inside a promise
                // method!
                await trx.step(() => {
                return doSomethingElse()
                .then(() => collection.save(data)); // WRONG
                });

                // BETTER: Perform any async logic needed outside the `trx.step` call
                await doSomethingElse();
                await trx.step(() => collection.save(data));

                // OKAY: You can perform async logic in the callback after the arangojs
                // method call as long as it does not involve additional arangojs method
                // calls, but this makes it easy to make mistakes later
                await trx.step(async () => {
                await collection.save(data);
                await doSomethingDifferent(); // no arangojs method calls allowed
                }); +
                +

                Example

                // BAD! The callback should not use any functions that themselves use any
                // arangojs methods!
                async function saveSomeData() {
                await collection.save(data);
                await collection.save(moreData);
                }
                await trx.step(() => saveSomeData()); // WRONG

                // BETTER: Pass the transaction to functions that need to call arangojs
                // methods inside a transaction
                async function saveSomeData(trx) {
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));
                }
                await saveSomeData(); // no `trx.step` call needed +
                +

                Example

                // BAD! You must wait for the promise to resolve (or await on the
                // `trx.step` call) before calling `trx.step` again!
                trx.step(() => collection.save(data)); // WRONG
                await trx.step(() => collection.save(moreData));

                // BAD! The trx.step callback can not make multiple calls to async arangojs
                // methods, not even using Promise.all!
                await trx.step(() => Promise.all([ // WRONG
                collection.save(data),
                collection.save(moreData),
                ]));

                // BAD! Multiple `trx.step` calls can not run in parallel!
                await Promise.all([ // WRONG
                trx.step(() => collection.save(data)),
                trx.step(() => collection.save(moreData)),
                ]));

                // BETTER: Always call `trx.step` sequentially, one after the other
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));

                // OKAY: The then callback can be used if async/await is not available
                trx.step(() => collection.save(data))
                .then(() => trx.step(() => collection.save(moreData))); +
                +

                Example

                // BAD! The callback will return an empty promise that resolves before
                // the inner arangojs method call has even talked to ArangoDB!
                await trx.step(async () => {
                collection.save(data); // WRONG
                });

                // BETTER: Use an arrow function so you don't forget to return
                await trx.step(() => collection.save(data));

                // OKAY: Remember to always return when using a function body
                await trx.step(() => {
                return collection.save(data); // easy to forget!
                });

                // OKAY: You do not have to use arrow functions but it helps
                await trx.step(function () {
                return collection.save(data);
                }); +
                +

                Example

                // BAD! You can not pass promises instead of a callback!
                await trx.step(collection.save(data)); // WRONG

                // BETTER: Wrap the code in a function and pass the function instead
                await trx.step(() => collection.save(data)); +
                +

                Example

                // WORSE: Calls to non-async arangojs methods don't need to be performed
                // as part of a transaction
                const collection = await trx.step(() => db.collection("my-documents"));

                // BETTER: If an arangojs method is not async and doesn't return promises,
                // call it without `trx.step`
                const collection = db.collection("my-documents"); +
                +

          Returns Promise<T>

    • Optional options: TransactionOptions

      Options for the transaction.

      +

    Returns Promise<T>

    Example

    const vertices = db.collection("vertices");
    const start = vertices.document("a");
    const end = vertices.document("b");
    const edges = db.collection("edges");
    await db.withTransaction(
    edges, // collection instances can be passed directly
    async (step) => {
    await step(() => edges.save({ _from: start._id, _to: end._id }));
    }
    ); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/error.ArangoError.html b/9.0.0-preview.1/classes/error.ArangoError.html new file mode 100644 index 000000000..93de592ea --- /dev/null +++ b/9.0.0-preview.1/classes/error.ArangoError.html @@ -0,0 +1,17 @@ +ArangoError | arangojs - v9.0.0-preview.1

Class ArangoError

Represents an error returned by ArangoDB.

+

Hierarchy

  • Error
    • ArangoError

Properties

code: number

HTTP status code included in the server error response object.

+
errorNum: number

ArangoDB error code.

+

See ArangoDB error documentation.

+
name: string = "ArangoError"
response: any

Server response object.

+
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Returns {
        code: number;
        error: boolean;
        errorMessage: string;
        errorNum: number;
    }

    • code: number
    • error: boolean
    • errorMessage: string
    • errorNum: number
  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

\ No newline at end of file diff --git a/9.0.0-preview.1/classes/error.HttpError.html b/9.0.0-preview.1/classes/error.HttpError.html new file mode 100644 index 000000000..15b97389f --- /dev/null +++ b/9.0.0-preview.1/classes/error.HttpError.html @@ -0,0 +1,14 @@ +HttpError | arangojs - v9.0.0-preview.1

Class HttpError

Represents a plain HTTP error response.

+

Hierarchy

  • Error
    • HttpError

Properties

code: number

HTTP status code of the server response.

+
name: string = "HttpError"
response: any

Server response object.

+
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Returns {
        code: number;
        error: boolean;
    }

    • code: number
    • error: boolean
  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

\ No newline at end of file diff --git a/9.0.0-preview.1/classes/graph.Graph.html b/9.0.0-preview.1/classes/graph.Graph.html new file mode 100644 index 000000000..eb5d5cf86 --- /dev/null +++ b/9.0.0-preview.1/classes/graph.Graph.html @@ -0,0 +1,107 @@ +Graph | arangojs - v9.0.0-preview.1

Represents a graph in a database.Database.

+

Accessors

  • get name(): string
  • Name of the graph.

    +

    Returns string

Methods

  • Adds an edge definition to this graph.

    +

    Parameters

    Returns Promise<GraphInfo>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    await graph.addEdgeDefinition({
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    });
    // The edge definition has been added to the graph +
    +
  • Adds the given collection to this graph as a vertex collection.

    +

    Parameters

    Returns Promise<GraphInfo>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    await graph.addVertexCollection("more-vertices");
    // The collection "more-vertices" has been added to the graph
    const extra = db.collection("extra-vertices");
    await graph.addVertexCollection(extra);
    // The collection "extra-vertices" has been added to the graph +
    +
  • Creates a graph with the given edgeDefinitions and options for this +graph's name.

    +

    Parameters

    Returns Promise<GraphInfo>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    // graph now exists +
    +
  • Deletes the graph from the database.

    +

    Parameters

    • dropCollections: boolean = false

      If set to true, the collections associated with +the graph will also be deleted.

      +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    await graph.drop();
    // the graph "some-graph" no longer exists +
    +
  • Returns a graph.GraphEdgeCollection instance for the given collection +name representing the collection in this graph.

    +

    Type Parameters

    • T extends Record<string, any> = any

      Type to use for document data. Defaults to any.

      +

    Parameters

    Returns GraphEdgeCollection<T>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const graphEdgeCollection = graph.edgeCollection("edges");
    // Access the underlying EdgeCollection API:
    const edgeCollection = graphEdgeCollection.collection; +
    +
  • Fetches all edge collections of this graph from the database and returns +an array of graph.GraphEdgeCollection instances.

    +

    See also graph.Graph#listEdgeCollections.

    +

    Returns Promise<GraphEdgeCollection<any>[]>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const graphEdgeCollections = await graph.edgeCollections();
    for (const collection of graphEdgeCollection) {
    console.log(collection.name);
    // "edges"
    } +
    +
  • Checks whether the graph exists.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const result = await graph.exists();
    // result indicates whether the graph exists +
    +
  • Retrieves general information about the graph.

    +

    Returns Promise<GraphInfo>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const data = await graph.get();
    // data contains general information about the graph +
    +
  • Fetches all edge collections of this graph from the database and returns +an array of their names.

    +

    See also graph.Graph#edgeCollections.

    +

    Returns Promise<string[]>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const edgeCollectionNames = await graph.listEdgeCollections();
    // ["edges"] +
    +
  • Fetches all vertex collections of this graph from the database and returns +an array of their names.

    +

    See also graph.Graph#vertexCollections.

    +

    Returns Promise<string[]>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const vertexCollectionNames = await graph.listVertexCollections();
    // ["start-vertices", "end-vertices"] +
    +
  • Removes the edge definition for the given edge collection from this graph.

    +

    Parameters

    • collection: string | ArangoCollection

      Edge collection for which to remove the definition.

      +
    • dropCollection: boolean = false

      If set to true, the collection will also be +deleted from the database.

      +

    Returns Promise<GraphInfo>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    await graph.removeEdgeDefinition("edges");
    // The edge definition for "edges" has been replaced +
    +
  • Removes the given collection from this graph as a vertex collection.

    +

    Parameters

    • collection: string | ArangoCollection

      Collection to remove from the graph.

      +
    • dropCollection: boolean = false

      If set to true, the collection will also be +deleted from the database.

      +

    Returns Promise<GraphInfo>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    await graph.removeVertexCollection("start-vertices");
    // The collection "start-vertices" is no longer part of the graph. +
    +
  • Replaces an edge definition in this graph. The existing edge definition +for the given edge collection will be overwritten.

    +

    Parameters

    Returns Promise<GraphInfo>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    await graph.replaceEdgeDefinition({
    collection: "edges",
    from: ["start-vertices"],
    to: ["other-vertices"],
    });
    // The edge definition for "edges" has been replaced +
    +
  • Replaces an edge definition in this graph. The existing edge definition +for the given edge collection will be overwritten.

    +

    Parameters

    Returns Promise<GraphInfo>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    await graph.replaceEdgeDefinition("edges", {
    collection: "edges",
    from: ["start-vertices"],
    to: ["other-vertices"],
    });
    // The edge definition for "edges" has been replaced +
    +
  • Performs a traversal starting from the given startVertex and following +edges contained in this graph.

    +

    See also collection.EdgeCollection#traversal.

    +

    Parameters

    • startVertex: string

      Document _id of a vertex in this graph.

      +
    • Optional options: TraversalOptions

      Options for performing the traversal.

      +

    Returns Promise<any>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and are +no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.

    +

    Example

    const db = new Database();
    const graph = db.graph("my-graph");
    const collection = graph.edgeCollection("edges").collection;
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/b", "vertices/c"],
    ["z", "vertices/c", "vertices/d"],
    ]);
    const startVertex = "vertices/a";
    const cursor = await db.query(aql`
    FOR vertex IN OUTBOUND ${startVertex} GRAPH ${graph}
    RETURN vertex._key
    `);
    const result = await cursor.all();
    console.log(result); // ["a", "b", "c", "d"] +
    +
  • Fetches all vertex collections of this graph from the database and returns +an array of graph.GraphVertexCollection instances.

    +

    See also graph.Graph#listVertexCollections.

    +

    Returns Promise<GraphVertexCollection<any>[]>

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const vertexCollections = await graph.vertexCollections();
    for (const vertexCollection of vertexCollections) {
    console.log(vertexCollection.name);
    // "start-vertices"
    // "end-vertices"
    } +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/graph.GraphEdgeCollection.html b/9.0.0-preview.1/classes/graph.GraphEdgeCollection.html new file mode 100644 index 000000000..ad1c46e98 --- /dev/null +++ b/9.0.0-preview.1/classes/graph.GraphEdgeCollection.html @@ -0,0 +1,73 @@ +GraphEdgeCollection | arangojs - v9.0.0-preview.1

Class GraphEdgeCollection<T>

Represents a collection.EdgeCollection of edges in a graph.Graph.

+

Type Parameters

  • T extends Record<string, any> = any

    Type to use for document data. Defaults to any.

    +

Implements

Accessors

Methods

  • Retrieves the edge matching the given key or id.

    +

    Throws an exception when passed a edge or _id from a different +collection, or if the edge does not exist.

    +

    Parameters

    Returns Promise<Edge<T>>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    try {
    const edge = await collection.edge("abc123");
    console.log(edge);
    } catch (e: any) {
    console.error("Could not find edge");
    } +
    +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    const edge = await collection.edge("abc123", { graceful: true });
    if (edge) {
    console.log(edge);
    } else {
    console.error("Edge does not exist");
    } +
    +
  • Retrieves the edge matching the given key or id.

    +

    Throws an exception when passed a edge or _id from a different +collection, or if the edge does not exist.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a edge from this collection).

      +
    • graceful: boolean

      If set to true, null is returned instead of an +exception being thrown if the edge does not exist.

      +

    Returns Promise<Edge<T>>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    try {
    const edge = await collection.edge("abc123", false);
    console.log(edge);
    } catch (e: any) {
    console.error("Could not find edge");
    } +
    +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    const edge = await collection.edge("abc123", true);
    if (edge) {
    console.log(edge);
    } else {
    console.error("Edge does not exist");
    } +
    +
  • Checks whether a edge matching the given key or id exists in this +collection.

    +

    Throws an exception when passed a edge or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a edge from this collection).

      +

    Returns Promise<boolean>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    const exists = await collection.edgeExists("abc123");
    if (!exists) {
    console.log("Edge does not exist");
    } +
    +
  • Removes an existing edge from the collection.

    +

    Throws an exception when passed a edge or _id from a different +collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        old?: Edge<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const doc = await collection.edge("musadir");
    await collection.remove(doc);
    // edge with key "musadir" deleted +
    +
  • Replaces an existing edge in the collection.

    +

    Throws an exception when passed a edge or _id from a different +collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    const result = await collection.replace(
    "musadir",
    { active: false },
    { returnNew: true }
    );
    console.log(result.new.active, result.new.best); // false undefined +
    +
  • Inserts a new edge with the given data into the collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        new?: Edge<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const result = await collection.save(
    { _from: "users/rana", _to: "users/mudasir", active: false },
    { returnNew: true }
    ); +
    +
  • Updates an existing edge in the collection.

    +

    Throws an exception when passed a edge or _id from a different +collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    const result = await collection.update(
    "musadir",
    { active: false },
    { returnNew: true }
    );
    console.log(result.new.active, result.new.best); // false true +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/graph.GraphVertexCollection.html b/9.0.0-preview.1/classes/graph.GraphVertexCollection.html new file mode 100644 index 000000000..d36eba067 --- /dev/null +++ b/9.0.0-preview.1/classes/graph.GraphVertexCollection.html @@ -0,0 +1,75 @@ +GraphVertexCollection | arangojs - v9.0.0-preview.1

Class GraphVertexCollection<T>

Represents a collection.DocumentCollection of vertices in a graph.Graph.

+

Type Parameters

  • T extends Record<string, any> = any

    Type to use for document data. Defaults to any.

    +

Implements

Accessors

Methods

  • Removes an existing vertex from the collection.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        old?: Document<T>;
    }>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    await collection.remove("abc123");
    // document with key "abc123" deleted +
    +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    const doc = await collection.vertex("abc123");
    await collection.remove(doc);
    // document with key "abc123" deleted +
    +
  • Replaces an existing vertex in the collection.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        new?: Document<T>;
        old?: Document<T>;
    }>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.collection("vertices");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    const result = await collection.replace(
    "a",
    { color: "red" },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "red" undefined +
    +
  • Inserts a new vertex with the given data into the collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        new?: Document<T>;
    }>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("friends");
    const result = await collection.save(
    { _key: "a", color: "blue", count: 1 },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "blue" 1 +
    +
  • Updates an existing vertex in the collection.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        new?: Document<T>;
        old?: Document<T>;
    }>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.collection("vertices");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    const result = await collection.update(
    "a",
    { count: 2 },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "blue" 2 +
    +
  • Retrieves the vertex matching the given key or id.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    +

    Parameters

    Returns Promise<Document<T>>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    try {
    const vertex = await collection.vertex("abc123");
    console.log(vertex);
    } catch (e: any) {
    console.error("Could not find vertex");
    } +
    +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    const vertex = await collection.vertex("abc123", { graceful: true });
    if (vertex) {
    console.log(vertex);
    } else {
    console.error("Could not find vertex");
    } +
    +
  • Retrieves the vertex matching the given key or id.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a vertex from this collection).

      +
    • graceful: boolean

      If set to true, null is returned instead of an +exception being thrown if the vertex does not exist.

      +

    Returns Promise<Document<T>>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    try {
    const vertex = await collection.vertex("abc123", false);
    console.log(vertex);
    } catch (e: any) {
    console.error("Could not find vertex");
    } +
    +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    const vertex = await collection.vertex("abc123", true);
    if (vertex) {
    console.log(vertex);
    } else {
    console.error("Could not find vertex");
    } +
    +
  • Checks whether a vertex matching the given key or id exists in this +collection.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a vertex from this collection).

      +

    Returns Promise<boolean>

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    const exists = await collection.vertexExists("abc123");
    if (!exists) {
    console.log("Vertex does not exist");
    } +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/job.Job.html b/9.0.0-preview.1/classes/job.Job.html new file mode 100644 index 000000000..92e8049e2 --- /dev/null +++ b/9.0.0-preview.1/classes/job.Job.html @@ -0,0 +1,21 @@ +Job | arangojs - v9.0.0-preview.1

Class Job<T>

Represents an async job in a database.Database.

+

Type Parameters

  • T = any

Accessors

  • get isLoaded(): boolean
  • Whether the job's results have been loaded. If set to true, the job's +result can be accessed from Job.result.

    +

    Returns boolean

  • get result(): undefined | T
  • The job's result if it has been loaded or undefined otherwise.

    +

    Returns undefined | T

Methods

  • Cancels the job if it is still running. Note that it may take some time to +actually cancel the job.

    +

    Returns Promise<void>

  • Deletes the result if it has not already been retrieved or deleted.

    +

    Returns Promise<void>

  • Fetches the job's completion state.

    +

    Returns true if the job has completed, false otherwise.

    +

    Returns Promise<boolean>

    Example

    // poll for the job to complete
    while (!(await job.getCompleted())) {
    await timeout(1000);
    }
    // job result is now available and can be loaded
    await job.load();
    console.log(job.result); +
    +
  • Loads the job's result from the database if it is not already loaded.

    +

    Returns Promise<undefined | T>

    Example

    // poll for the job to complete
    while (!job.isLoaded) {
    await timeout(1000);
    const result = await job.load();
    console.log(result);
    }
    // job result is now loaded and can also be accessed from job.result
    console.log(job.result); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/route.Route.html b/9.0.0-preview.1/classes/route.Route.html new file mode 100644 index 000000000..8804a6fd0 --- /dev/null +++ b/9.0.0-preview.1/classes/route.Route.html @@ -0,0 +1,108 @@ +Route | arangojs - v9.0.0-preview.1

Represents an arbitrary route relative to an ArangoDB database.

+

Methods

  • Performs a DELETE request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • path: string

      Path relative to this route.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.delete("/users/admin"); +
    +
  • Performs a DELETE request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const user = foxx.roue("/users/admin");
    const res = await user.delete(); +
    +
  • Performs a GET request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • path: string

      Path relative to this route.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.get("/users", { offset: 10, limit: 5 }); +
    +
  • Performs a GET request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const users = foxx.route("/users");
    const res = await users.get({ offset: 10, limit: 5 }); +
    +
  • Performs a HEAD request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • path: string

      Path relative to this route.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.head("/users", { offset: 10, limit: 5 }); +
    +
  • Performs a HEAD request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const users = foxx.route("/users");
    const res = await users.head({ offset: 10, limit: 5 }); +
    +
  • Performs a PATCH request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • path: string

      Path relative to this route.

      +
    • Optional body: any

      Body of the request object.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.patch("/users/admin", { password: "admin" }); +
    +
  • Performs a PATCH request against the given path relative to this route +and returns the server response.

    +

    Note: body must not be a string.

    +

    Parameters

    • Optional body: any

      Body of the request object. Must not be a string.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const user = foxx.route("/users/admin")
    const res = await user.patch({ password: "admin" }); +
    +
  • Performs a POST request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • path: string

      Path relative to this route.

      +
    • Optional body: any

      Body of the request object.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.post("/users", {
    username: "admin",
    password: "hunter2"
    }); +
    +
  • Performs a POST request against the given path relative to this route +and returns the server response.

    +

    Note: body must not be a string.

    +

    Parameters

    • Optional body: any

      Body of the request object. Must not be a string.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const users = foxx.route("/users");
    const res = await users.post({
    username: "admin",
    password: "hunter2"
    }); +
    +
  • Performs a PUT request against the given path relative to this route +and returns the server response.

    +

    Parameters

    • path: string

      Path relative to this route.

      +
    • Optional body: any

      Body of the request object.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.put("/users/admin/password", { password: "admin" }); +
    +
  • Performs a PUT request against the given path relative to this route +and returns the server response.

    +

    Note: body must not be a string.

    +

    Parameters

    • Optional body: any

      Body of the request object. Must not be a string.

      +
    • Optional search: Record<string, any> | URLSearchParams

      Query string parameters for this request.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers to send with this request.

      +

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const password = foxx.route("/users/admin/password");
    const res = await password.put({ password: "admin" }); +
    +
  • Performs an arbitrary HTTP request relative to this route and returns the +server response.

    +

    Parameters

    Returns Promise<ArangojsResponse>

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.request({
    method: "POST",
    path: "/users",
    body: {
    username: "admin",
    password: "hunter2"
    }
    }); +
    +
  • Creates a new route relative to this route that inherits any of its default +HTTP headers.

    +

    Parameters

    • path: string

      Path relative to this route.

      +
    • Optional headers: Headers | Record<string, string>

      Additional headers that will be sent with each request.

      +

    Returns Route

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const users = foxx.route("/users"); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/transaction.Transaction.html b/9.0.0-preview.1/classes/transaction.Transaction.html new file mode 100644 index 000000000..154aa5e33 --- /dev/null +++ b/9.0.0-preview.1/classes/transaction.Transaction.html @@ -0,0 +1,59 @@ +Transaction | arangojs - v9.0.0-preview.1

Represents a streaming transaction in a database.Database.

+

Accessors

id +

Methods

Accessors

Methods

  • Attempts to abort the transaction to the databases.

    +

    Parameters

    Returns Promise<TransactionStatus>

    Example

    const db = new Database();
    const col = db.collection("some-collection");
    const trx = db.beginTransaction(col);
    await trx.step(() => col.save({ hello: "world" }));
    const result = await trx.abort();
    // result indicates the updated transaction status +
    +
  • Attempts to commit the transaction to the databases.

    +

    Parameters

    Returns Promise<TransactionStatus>

    Example

    const db = new Database();
    const col = db.collection("some-collection");
    const trx = db.beginTransaction(col);
    await trx.step(() => col.save({ hello: "world" }));
    const result = await trx.commit();
    // result indicates the updated transaction status +
    +
  • Checks whether the transaction exists.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const trx = db.transaction("some-transaction");
    const result = await trx.exists();
    // result indicates whether the transaction exists +
    +
  • Retrieves general information about the transaction.

    +

    Returns Promise<TransactionStatus>

    Example

    const db = new Database();
    const col = db.collection("some-collection");
    const trx = db.beginTransaction(col);
    await trx.step(() => col.save({ hello: "world" }));
    const info = await trx.get();
    // the transaction exists +
    +
  • Executes the given function locally as a single step of the transaction.

    +

    Type Parameters

    • T

      Type of the callback's returned promise.

      +

    Parameters

    • callback: (() => Promise<T>)

      Callback function returning a promise.

      +

      Warning: The callback function should wrap a single call of an async +arangojs method (e.g. a method on a Collection object of a collection +that is involved in the transaction or the db.query method). +If the callback function is async, only the first promise-returning (or +async) method call will be executed as part of the transaction. See the +examples below for how to avoid common mistakes when using this method.

      +

      Note: Avoid defining the callback as an async function if possible +as arangojs will throw an error if the callback did not return a promise. +Async functions will return an empty promise by default, making it harder +to notice if you forgot to return something from the callback.

      +

      Note: Although almost anything can be wrapped in a callback and passed +to this method, that does not guarantee ArangoDB can actually do it in a +transaction. Refer to the ArangoDB documentation if you are unsure whether +a given operation can be executed as part of a transaction. Generally any +modification or retrieval of data is eligible but modifications of +collections or databases are not.

      +
        • (): Promise<T>
        • Returns Promise<T>

    Returns Promise<T>

    Example

    const db = new Database();
    const vertices = db.collection("vertices");
    const edges = db.collection("edges");
    const trx = await db.beginTransaction({ write: [vertices, edges] });

    // The following code will be part of the transaction
    const left = await trx.step(() => vertices.save({ label: "left" }));
    const right = await trx.step(() => vertices.save({ label: "right" }));

    // Results from preceding actions can be used normally
    await trx.step(() => edges.save({
    _from: left._id,
    _to: right._id,
    data: "potato"
    }));

    // Transaction must be committed for changes to take effected
    // Always call either trx.commit or trx.abort to end a transaction
    await trx.commit(); +
    +

    Example

    // BAD! If the callback is an async function it must only use await once!
    await trx.step(async () => {
    await collection.save(data);
    await collection.save(moreData); // WRONG
    });

    // BAD! Callback function must use only one arangojs call!
    await trx.step(() => {
    return collection.save(data)
    .then(() => collection.save(moreData)); // WRONG
    });

    // BETTER: Wrap every arangojs method call that should be part of the
    // transaction in a separate `trx.step` call
    await trx.step(() => collection.save(data));
    await trx.step(() => collection.save(moreData)); +
    +

    Example

    // BAD! If the callback is an async function it must not await before
    // calling an arangojs method!
    await trx.step(async () => {
    await doSomethingElse();
    return collection.save(data); // WRONG
    });

    // BAD! Any arangojs inside the callback must not happen inside a promise
    // method!
    await trx.step(() => {
    return doSomethingElse()
    .then(() => collection.save(data)); // WRONG
    });

    // BETTER: Perform any async logic needed outside the `trx.step` call
    await doSomethingElse();
    await trx.step(() => collection.save(data));

    // OKAY: You can perform async logic in the callback after the arangojs
    // method call as long as it does not involve additional arangojs method
    // calls, but this makes it easy to make mistakes later
    await trx.step(async () => {
    await collection.save(data);
    await doSomethingDifferent(); // no arangojs method calls allowed
    }); +
    +

    Example

    // BAD! The callback should not use any functions that themselves use any
    // arangojs methods!
    async function saveSomeData() {
    await collection.save(data);
    await collection.save(moreData);
    }
    await trx.step(() => saveSomeData()); // WRONG

    // BETTER: Pass the transaction to functions that need to call arangojs
    // methods inside a transaction
    async function saveSomeData(trx) {
    await trx.step(() => collection.save(data));
    await trx.step(() => collection.save(moreData));
    }
    await saveSomeData(); // no `trx.step` call needed +
    +

    Example

    // BAD! You must wait for the promise to resolve (or await on the
    // `trx.step` call) before calling `trx.step` again!
    trx.step(() => collection.save(data)); // WRONG
    await trx.step(() => collection.save(moreData));

    // BAD! The trx.step callback can not make multiple calls to async arangojs
    // methods, not even using Promise.all!
    await trx.step(() => Promise.all([ // WRONG
    collection.save(data),
    collection.save(moreData),
    ]));

    // BAD! Multiple `trx.step` calls can not run in parallel!
    await Promise.all([ // WRONG
    trx.step(() => collection.save(data)),
    trx.step(() => collection.save(moreData)),
    ]));

    // BETTER: Always call `trx.step` sequentially, one after the other
    await trx.step(() => collection.save(data));
    await trx.step(() => collection.save(moreData));

    // OKAY: The then callback can be used if async/await is not available
    trx.step(() => collection.save(data))
    .then(() => trx.step(() => collection.save(moreData))); +
    +

    Example

    // BAD! The callback will return an empty promise that resolves before
    // the inner arangojs method call has even talked to ArangoDB!
    await trx.step(async () => {
    collection.save(data); // WRONG
    });

    // BETTER: Use an arrow function so you don't forget to return
    await trx.step(() => collection.save(data));

    // OKAY: Remember to always return when using a function body
    await trx.step(() => {
    return collection.save(data); // easy to forget!
    });

    // OKAY: You do not have to use arrow functions but it helps
    await trx.step(function () {
    return collection.save(data);
    }); +
    +

    Example

    // BAD! You can not pass promises instead of a callback!
    await trx.step(collection.save(data)); // WRONG

    // BETTER: Wrap the code in a function and pass the function instead
    await trx.step(() => collection.save(data)); +
    +

    Example

    // WORSE: Calls to non-async arangojs methods don't need to be performed
    // as part of a transaction
    const collection = await trx.step(() => db.collection("my-documents"));

    // BETTER: If an arangojs method is not async and doesn't return promises,
    // call it without `trx.step`
    const collection = db.collection("my-documents"); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/classes/view.View.html b/9.0.0-preview.1/classes/view.View.html new file mode 100644 index 000000000..8443d830f --- /dev/null +++ b/9.0.0-preview.1/classes/view.View.html @@ -0,0 +1,44 @@ +View | arangojs - v9.0.0-preview.1

Represents a View in a database.Database.

+

Accessors

  • get name(): string
  • Name of the View.

    +

    Returns string

Methods

  • Deletes the View from the database.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const view = db.view("some-view");
    await view.drop();
    // the View "some-view" no longer exists +
    +
  • Checks whether the View exists.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const view = db.view("some-view");
    const exists = await view.exists();
    console.log(exists); // indicates whether the View exists +
    +
  • Renames the View and updates the instance's name to newName.

    +

    Additionally removes the instance from the database.Database's internal +cache.

    +

    Note: Renaming Views may not be supported when ArangoDB is +running in a cluster configuration.

    +

    Parameters

    • newName: string

      The new name of the View.

      +

    Returns Promise<ArangoApiResponse<ViewDescription>>

    Example

    const db = new Database();
    const view1 = db.view("some-view");
    await view1.rename("other-view");
    const view2 = db.view("some-view");
    const view3 = db.view("other-view");
    // Note all three View instances are different objects but
    // view1 and view3 represent the same ArangoDB view! +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/enums/collection.CollectionStatus.html b/9.0.0-preview.1/enums/collection.CollectionStatus.html new file mode 100644 index 000000000..8dca093db --- /dev/null +++ b/9.0.0-preview.1/enums/collection.CollectionStatus.html @@ -0,0 +1,8 @@ +CollectionStatus | arangojs - v9.0.0-preview.1

Enumeration CollectionStatus

Integer values indicating the collection loading status.

+

Enumeration Members

Enumeration Members

DELETED: 5
LOADED: 3
LOADING: 6
NEWBORN: 1
UNLOADED: 2
UNLOADING: 4
\ No newline at end of file diff --git a/9.0.0-preview.1/enums/collection.CollectionType.html b/9.0.0-preview.1/enums/collection.CollectionType.html new file mode 100644 index 000000000..e82ea39fc --- /dev/null +++ b/9.0.0-preview.1/enums/collection.CollectionType.html @@ -0,0 +1,4 @@ +CollectionType | arangojs - v9.0.0-preview.1

Enumeration CollectionType

Integer values indicating the collection type.

+

Enumeration Members

Enumeration Members

DOCUMENT_COLLECTION: 2
EDGE_COLLECTION: 3
\ No newline at end of file diff --git a/9.0.0-preview.1/enums/database.LogLevel.html b/9.0.0-preview.1/enums/database.LogLevel.html new file mode 100644 index 000000000..845853c18 --- /dev/null +++ b/9.0.0-preview.1/enums/database.LogLevel.html @@ -0,0 +1,7 @@ +LogLevel | arangojs - v9.0.0-preview.1

Enumeration LogLevel

Numeric representation of the logging level of a log entry.

+

Enumeration Members

Enumeration Members

DEBUG: 4
ERROR: 1
FATAL: 0
INFO: 3
WARNING: 2
\ No newline at end of file diff --git a/9.0.0-preview.1/functions/analyzer.isArangoAnalyzer.html b/9.0.0-preview.1/functions/analyzer.isArangoAnalyzer.html new file mode 100644 index 000000000..4d7a7d297 --- /dev/null +++ b/9.0.0-preview.1/functions/analyzer.isArangoAnalyzer.html @@ -0,0 +1,3 @@ +isArangoAnalyzer | arangojs - v9.0.0-preview.1

Function isArangoAnalyzer

  • Indicates whether the given value represents an Analyzer.

    +

    Parameters

    • analyzer: any

      A value that might be an Analyzer.

      +

    Returns analyzer is Analyzer

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/aql.aql.html b/9.0.0-preview.1/functions/aql.aql.html new file mode 100644 index 000000000..5e8a1805d --- /dev/null +++ b/9.0.0-preview.1/functions/aql.aql.html @@ -0,0 +1,23 @@ +aql | arangojs - v9.0.0-preview.1

Function aql

  • Template string handler (template tag) for AQL queries.

    +

    The aql tag can be used to write complex AQL queries as multi-line strings +without having to worry about bindVars and the distinction between +collections and regular parameters.

    +

    Tagged template strings will return an AqlQuery object with +query and bindVars attributes reflecting any interpolated values.

    +

    Any collection.ArangoCollection instance used in a query string will +be recognized as a collection reference and generate an AQL collection bind +parameter instead of a regular AQL value bind parameter.

    +

    Note: you should always use the aql template tag when writing +dynamic AQL queries instead of using untagged (normal) template strings. +Untagged template strings will inline any interpolated values and return +a plain string as result. The aql template tag will only inline references +to the interpolated values and produce an AQL query object containing both +the query and the values. This prevents most injection attacks when using +untrusted values in dynamic queries.

    +

    Type Parameters

    • T = any

    Parameters

    • templateStrings: TemplateStringsArray
    • Rest ...args: AqlValue[]

    Returns AqlQuery<T>

    Example

    // Some user-supplied string that may be malicious
    const untrustedValue = req.body.email;

    // Without aql tag: BAD! DO NOT DO THIS!
    const badQuery = `
    FOR user IN users
    FILTER user.email == "${untrustedValue}"
    RETURN user
    `;
    // e.g. if untrustedValue is '" || user.admin == true || "':
    // Query:
    // FOR user IN users
    // FILTER user.email == "" || user.admin == true || ""
    // RETURN user

    // With the aql tag: GOOD! MUCH SAFER!
    const betterQuery = aql`
    FOR user IN users
    FILTER user.email == ${untrustedValue}
    RETURN user
    `;
    // Query:
    // FOR user IN users
    // FILTER user.email == @value0
    // RETURN user
    // Bind parameters:
    // value0 -> untrustedValue +
    +

    Example

    const collection = db.collection("some-collection");
    const minValue = 23;
    const result = await db.query(aql`
    FOR d IN ${collection}
    FILTER d.num > ${minValue}
    RETURN d
    `);

    // Equivalent raw query object
    const result2 = await db.query({
    query: `
    FOR d IN @@collection
    FILTER d.num > @minValue
    RETURN d
    `,
    bindVars: {
    "@collection": collection.name,
    minValue: minValue
    }
    }); +
    +

    Example

    const collection = db.collection("some-collection");
    const color = "green";
    const filter = aql`FILTER d.color == ${color}'`;
    const result = await db.query(aql`
    FOR d IN ${collection}
    ${filter}
    RETURN d
    `); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/functions/aql.isAqlLiteral.html b/9.0.0-preview.1/functions/aql.isAqlLiteral.html new file mode 100644 index 000000000..d770aad2f --- /dev/null +++ b/9.0.0-preview.1/functions/aql.isAqlLiteral.html @@ -0,0 +1,3 @@ +isAqlLiteral | arangojs - v9.0.0-preview.1

Function isAqlLiteral

  • Indicates whether the given value is an AqlLiteral.

    +

    Parameters

    • literal: any

      A value that might be an AqlLiteral.

      +

    Returns literal is AqlLiteral

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/aql.isAqlQuery.html b/9.0.0-preview.1/functions/aql.isAqlQuery.html new file mode 100644 index 000000000..0292c4bc4 --- /dev/null +++ b/9.0.0-preview.1/functions/aql.isAqlQuery.html @@ -0,0 +1,3 @@ +isAqlQuery | arangojs - v9.0.0-preview.1

Function isAqlQuery

  • Indicates whether the given value is an AqlQuery.

    +

    Parameters

    • query: any

      A value that might be an AqlQuery.

      +

    Returns query is AqlQuery<any>

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/aql.join.html b/9.0.0-preview.1/functions/aql.join.html new file mode 100644 index 000000000..23eb89d93 --- /dev/null +++ b/9.0.0-preview.1/functions/aql.join.html @@ -0,0 +1,15 @@ +join | arangojs - v9.0.0-preview.1

Function join

  • Constructs AqlQuery objects from an array of arbitrary values.

    +

    Note: Nesting aql template strings is a much safer alternative +for most use cases. This low-level helper function only exists to +complement the aql tag when constructing complex queries from dynamic +arrays of query fragments.

    +

    Parameters

    • values: AqlValue[]

      Array of values to join. These values will behave exactly +like values interpolated in an aql template string.

      +
    • sep: string = " "

      Seperator to insert between values. This value will behave +exactly like a value passed to literal, i.e. it will be +inlined as-is, rather than being converted into a bind parameter.

      +

    Returns AqlQuery

    Example

    const users = db.collection("users");
    const filters = [];
    if (adminsOnly) filters.push(aql`FILTER user.admin`);
    if (activeOnly) filters.push(aql`FILTER user.active`);
    const result = await db.query(aql`
    FOR user IN ${users}
    ${join(filters)}
    RETURN user
    `); +
    +

    Example

    const users = db.collection("users");
    const keys = ["jreyes", "ghermann"];

    // BAD! NEEDLESSLY COMPLEX!
    const docs = keys.map(key => aql`DOCUMENT(${users}, ${key}`));
    const result = await db.query(aql`
    FOR user IN [
    ${join(docs, ", ")}
    ]
    RETURN user
    `);
    // Query:
    // FOR user IN [
    // DOCUMENT(@@value0, @value1), DOCUMENT(@@value0, @value2)
    // ]
    // RETURN user
    // Bind parameters:
    // @value0 -> "users"
    // value1 -> "jreyes"
    // value2 -> "ghermann"

    // GOOD! MUCH SIMPLER!
    const result = await db.query(aql`
    FOR key IN ${keys}
    LET user = DOCUMENT(${users}, key)
    RETURN user
    `);
    // Query:
    // FOR user IN @value0
    // LET user = DOCUMENT(@@value1, key)
    // RETURN user
    // Bind parameters:
    // value0 -> ["jreyes", "ghermann"]
    // @value1 -> "users" +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/functions/aql.literal.html b/9.0.0-preview.1/functions/aql.literal.html new file mode 100644 index 000000000..c662e1e47 --- /dev/null +++ b/9.0.0-preview.1/functions/aql.literal.html @@ -0,0 +1,15 @@ +literal | arangojs - v9.0.0-preview.1

Function literal

  • Marks an arbitrary scalar value (i.e. a string, number or boolean) as +safe for being inlined directly into AQL queries when used in an aql +template string, rather than being converted into a bind parameter.

    +

    Note: Nesting aql template strings is a much safer alternative for +most use cases. This low-level helper function only exists to help with +rare edge cases where a trusted AQL query fragment must be read from a +string (e.g. when reading query fragments from JSON) and should only be +used as a last resort.

    +

    Parameters

    • value: undefined | null | string | number | boolean | AqlLiteral

    Returns AqlLiteral

    Example

    // BAD! DO NOT DO THIS!
    const sortDirection = literal('ASC');

    // GOOD! DO THIS INSTEAD!
    const sortDirection = aql`ASC`; +
    +

    Example

    // BAD! DO NOT DO THIS!
    const filterColor = literal('FILTER d.color == "green"');
    const result = await db.query(aql`
    FOR d IN some-collection
    ${filterColor}
    RETURN d
    `);

    // GOOD! DO THIS INSTEAD!
    const color = "green";
    const filterColor = aql`FILTER d.color === ${color}`;
    const result = await db.query(aql`
    FOR d IN some-collection
    ${filterColor}
    RETURN d
    `); +
    +

    Example

    // WARNING: We explicitly trust the environment variable to be safe!
    const filter = literal(process.env.FILTER_STATEMENT);
    const users = await db.query(aql`
    FOR user IN users
    ${filter}
    RETURN user
    `); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/functions/collection.collectionToString.html b/9.0.0-preview.1/functions/collection.collectionToString.html new file mode 100644 index 000000000..6773db527 --- /dev/null +++ b/9.0.0-preview.1/functions/collection.collectionToString.html @@ -0,0 +1,4 @@ +collectionToString | arangojs - v9.0.0-preview.1

Function collectionToString

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/collection.isArangoCollection.html b/9.0.0-preview.1/functions/collection.isArangoCollection.html new file mode 100644 index 000000000..c130bcef0 --- /dev/null +++ b/9.0.0-preview.1/functions/collection.isArangoCollection.html @@ -0,0 +1,3 @@ +isArangoCollection | arangojs - v9.0.0-preview.1

Function isArangoCollection

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/database.isArangoDatabase.html b/9.0.0-preview.1/functions/database.isArangoDatabase.html new file mode 100644 index 000000000..29377e85c --- /dev/null +++ b/9.0.0-preview.1/functions/database.isArangoDatabase.html @@ -0,0 +1,3 @@ +isArangoDatabase | arangojs - v9.0.0-preview.1

Function isArangoDatabase

  • Indicates whether the given value represents a Database.

    +

    Parameters

    • database: any

      A value that might be a database.

      +

    Returns database is Database

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/error.isArangoError.html b/9.0.0-preview.1/functions/error.isArangoError.html new file mode 100644 index 000000000..128e0c462 --- /dev/null +++ b/9.0.0-preview.1/functions/error.isArangoError.html @@ -0,0 +1,3 @@ +isArangoError | arangojs - v9.0.0-preview.1

Function isArangoError

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/error.isSystemError.html b/9.0.0-preview.1/functions/error.isSystemError.html new file mode 100644 index 000000000..e26588452 --- /dev/null +++ b/9.0.0-preview.1/functions/error.isSystemError.html @@ -0,0 +1,2 @@ +isSystemError | arangojs - v9.0.0-preview.1

Function isSystemError

  • Indicates whether the given value represents a Node.js SystemError.

    +

    Parameters

    • err: any

    Returns err is SystemError

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/graph.isArangoGraph.html b/9.0.0-preview.1/functions/graph.isArangoGraph.html new file mode 100644 index 000000000..b6016b3a9 --- /dev/null +++ b/9.0.0-preview.1/functions/graph.isArangoGraph.html @@ -0,0 +1,3 @@ +isArangoGraph | arangojs - v9.0.0-preview.1

Function isArangoGraph

  • Indicates whether the given value represents a graph.Graph.

    +

    Parameters

    • graph: any

      A value that might be a Graph.

      +

    Returns graph is Graph

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/index.arangojs.html b/9.0.0-preview.1/functions/index.arangojs.html new file mode 100644 index 000000000..420f6d3ae --- /dev/null +++ b/9.0.0-preview.1/functions/index.arangojs.html @@ -0,0 +1,12 @@ +arangojs | arangojs - v9.0.0-preview.1

Function arangojs

  • Creates a new Database instance with its own connection pool.

    +

    This is a wrapper function for the database.Database:constructor.

    +

    Parameters

    • Optional config: Config

      An object with configuration options.

      +

    Returns Database

    Example

    const db = arangojs({
    url: "http://127.0.0.1:8529",
    databaseName: "myDatabase",
    auth: { username: "admin", password: "hunter2" },
    }); +
    +
  • Creates a new Database instance with its own connection pool.

    +

    This is a wrapper function for the database.Database:constructor.

    +

    Parameters

    • url: string | string[]

      Base URL of the ArangoDB server or list of server URLs. +Equivalent to the url option in connection.Config.

      +
    • Optional name: string

    Returns Database

    Example

    const db = arangojs("http://127.0.0.1:8529", "myDatabase");
    db.useBasicAuth("admin", "hunter2"); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/functions/transaction.isArangoTransaction.html b/9.0.0-preview.1/functions/transaction.isArangoTransaction.html new file mode 100644 index 000000000..15db842b0 --- /dev/null +++ b/9.0.0-preview.1/functions/transaction.isArangoTransaction.html @@ -0,0 +1,3 @@ +isArangoTransaction | arangojs - v9.0.0-preview.1

Function isArangoTransaction

\ No newline at end of file diff --git a/9.0.0-preview.1/functions/view.isArangoView.html b/9.0.0-preview.1/functions/view.isArangoView.html new file mode 100644 index 000000000..6bf8b7e4e --- /dev/null +++ b/9.0.0-preview.1/functions/view.isArangoView.html @@ -0,0 +1,3 @@ +isArangoView | arangojs - v9.0.0-preview.1

Function isArangoView

  • Indicates whether the given value represents a View.

    +

    Parameters

    • view: any

      A value that might be a View.

      +

    Returns view is View

\ No newline at end of file diff --git a/9.0.0-preview.1/hierarchy.html b/9.0.0-preview.1/hierarchy.html new file mode 100644 index 000000000..a59ee3869 --- /dev/null +++ b/9.0.0-preview.1/hierarchy.html @@ -0,0 +1 @@ +arangojs - v9.0.0-preview.1
\ No newline at end of file diff --git a/9.0.0-preview.1/index.html b/9.0.0-preview.1/index.html new file mode 100644 index 000000000..7f2390ac9 --- /dev/null +++ b/9.0.0-preview.1/index.html @@ -0,0 +1,153 @@ +arangojs - v9.0.0-preview.1

arangojs - v9.0.0-preview.1

ArangoDB JavaScript Driver

The official ArangoDB JavaScript client for Node.js and the browser.

+

license - APACHE-2.0 +Tests

+

npm package status

+

Links

+

Install

With npm or yarn

npm install --save arangojs
## - or -
yarn add arangojs +
+

For browsers

When using modern JavaScript tooling with a bundler and compiler (e.g. Babel), +arangojs can be installed using npm or yarn like any other dependency.

+

For use without a compiler, the npm release comes with a precompiled browser +build for evergreen browsers:

+
var arangojs = require("arangojs/web");
+
+

You can also use unpkg during development:

+
< !-- note the path includes the version number (e.g. 8.0.0) -- >
<script src="https://unpkg.com/arangojs@8.0.0/web.js"></script>
<script>
var db = new arangojs.Database();
// ...
</script> +
+

When loading the browser build with a script tag make sure to load the polyfill first:

+
<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/6.26.0/polyfill.js"></script>
<script src="https://unpkg.com/arangojs@8.0.0/web.js"></script> +
+

Basic usage example

Modern JavaScript/TypeScript with async/await:

+
// TS: import { Database, aql } from "arangojs";
const { Database, aql } = require("arangojs");

const db = new Database();
const Pokemons = db.collection("my-pokemons");

async function main() {
try {
const pokemons = await db.query(aql`
FOR pokemon IN ${Pokemons}
FILTER pokemon.type == "fire"
RETURN pokemon
`);
console.log("My pokemons, let me show you them:");
for await (const pokemon of pokemons) {
console.log(pokemon.name);
}
} catch (err) {
console.error(err.message);
}
}

main(); +
+

Using a different database:

+
const db = new Database({
url: "http://127.0.0.1:8529",
databaseName: "pancakes",
auth: { username: "root", password: "hunter2" },
});

// The credentials can be swapped at any time
db.useBasicAuth("admin", "maplesyrup"); +
+

Old-school JavaScript with promises:

+
var arangojs = require("arangojs");
var Database = arangojs.Database;

var db = new Database();
var pokemons = db.collection("pokemons");

db.query({
query: "FOR p IN @@c FILTER p.type == 'fire' RETURN p",
bindVars: { "@c": "pokemons" },
})
.then(function (cursor) {
console.log("My pokemons, let me show you them:");
return cursor.forEach(function (pokemon) {
console.log(pokemon.name);
});
})
.catch(function (err) {
console.error(err.message);
}); +
+

Note: The examples throughout this documentation use async/await +and other modern language features like multi-line strings and template tags. +When developing for an environment without support for these language features, +substitute promises for await syntax as in the above example.

+

Compatibility

The arangojs driver is compatible with the latest stable version of ArangoDB +available at the time of the driver release and remains compatible with the +two most recent Node.js LTS versions in accordance with the official +Node.js long-term support schedule. Versions +of ArangoDB that have reached their end of life +by the time of a driver release are explicitly not supported.

+

For a list of changes between recent versions of the driver, see the +CHANGELOG.

+

Note: arangojs is only intended to be used in Node.js or a browser to access +ArangoDB from outside the database. If you are looking for the ArangoDB +JavaScript API for Foxx or for accessing ArangoDB +from within the arangosh interactive shell, please refer to the documentation +of the @arangodb module +and the db object instead.

+

Error responses

If arangojs encounters an API error, it will throw an ArangoError with +an errorNum property indicating the ArangoDB error code and the code +property indicating the HTTP status code from the response body.

+

For any other non-ArangoDB error responses (4xx/5xx status code), it will throw +an HttpError error with the status code indicated by the code property.

+

If the server response did not indicate an error but the response body could +not be parsed, a regular SyntaxError may be thrown instead.

+

In all of these cases the server response object will be exposed as the +response property on the error object.

+

If the request failed at a network level or the connection was closed without +receiving a response, the underlying system error will be thrown instead.

+

Common issues

Missing functions or unexpected server errors

Please make sure you are using the latest version of this driver and that the +version of the arangojs documentation you are reading matches that version.

+

Changes in the major version number of arangojs (e.g. 7.x.y -> 8.0.0) indicate +backwards-incompatible changes in the arangojs API that may require changes in +your code when upgrading your version of arangojs.

+

Additionally please ensure that your version of Node.js (or browser) and +ArangoDB are supported by the version of arangojs you are trying to use. See +the compatibility section for additional information.

+

Note: As of June 2018 ArangoDB 2.8 has reached its End of Life and is no +longer supported in arangojs 7 and later. If your code needs to work with +ArangoDB 2.8 you can continue using arangojs 6 and enable ArangoDB 2.8 +compatibility mode by setting the config option arangoVersion: 20800 to +enable the ArangoDB 2.8 compatibility mode in arangojs 6.

+

You can install an older version of arangojs using npm or yarn:

+
# for version 6.x.x
yarn add arangojs@6
# - or -
npm install --save arangojs@6 +
+

No code intelligence when using require instead of import

If you are using require to import the arangojs module in JavaScript, the +default export might not be recognized as a function by the code intelligence +of common editors like Visual Studio Code, breaking auto-complete and other +useful features.

+

As a workaround, use the arangojs function exported by that module instead +of calling the module itself:

+
  const arangojs = require("arangojs");

- const db = arangojs({
+ const db = arangojs.arangojs({
url: ARANGODB_SERVER,
}); +
+

Alternatively you can use the Database class directly:

+
  const arangojs = require("arangojs");
+ const Database = arangojs.Database;

- const db = arangojs({
+ const db = new Database({
url: ARANGODB_SERVER,
}); +
+

Or using object destructuring:

+
- const arangojs = require("arangojs");
+ const { Database } = require("arangojs");

- const db = arangojs({
+ const db = new Database({
url: ARANGODB_SERVER,
}); +
+

Error stack traces contain no useful information

Due to the async, queue-based behavior of arangojs, the stack traces generated +when an error occur rarely provide enough information to determine the location +in your own code where the request was initiated.

+

Using the precaptureStackTraces configuration option, arangojs will attempt +to always generate stack traces proactively when a request is performed, +allowing arangojs to provide more meaningful stack traces at the cost of an +impact to performance even when no error occurs.

+
  const { Database } = require("arangojs");

const db = new Database({
url: ARANGODB_SERVER,
+ precaptureStackTraces: true,
}); +
+

Note that arangojs will attempt to use Error.captureStackTrace if available +and fall back to generating a stack trace by throwing an error. In environments +that do not support the stack property on error objects, this option will +still impact performance but not result in any additional information becoming +available.

+

Node.js ReferenceError: window is not defined

If you compile your Node project using a build tool like Webpack, you may need +to tell it to +target the correct environment:

+
// webpack.config.js
+ "target": "node", +
+

To support use in both browser and Node environments arangojs uses the +package.json browser field, +to substitute browser-specific implementations for certain modules. +Build tools like Webpack will respect this field when targetting a browser +environment and may need to be explicitly told you are targetting Node instead.

+

Node.js with self-signed HTTPS certificates

If you need to support self-signed HTTPS certificates in Node.js, you may have +to override the global fetch agent. At the time of this writing, there is no +official way to do this for the native fetch implementation in Node.js.

+

However as Node.js uses the undici module for its fetch implementation +internally, you can override the global agent by adding undici as a +dependency to your project and using its setGlobalDispatcher as follows:

+
const { Agent, setGlobalDispatcher } = require("undici");

setGlobalDispatcher(
new Agent({
ca: [
fs.readFileSync(".ssl/sub.class1.server.ca.pem"),
fs.readFileSync(".ssl/ca.pem"),
],
})
); +
+

Although this is strongly discouraged, it's also possible to disable +HTTPS certificate validation entirely, but note this has +extremely dangerous security implications:

+
const { Agent, setGlobalDispatcher } = require("undici");

setGlobalDispatcher(
new Agent({
rejectUnauthorized: false,
})
); +
+

When using arangojs in the browser, self-signed HTTPS certificates need to +be trusted by the browser or use a trusted root certificate.

+

Streaming transactions leak

When using the transaction.step method it is important to be aware of the +limitations of what a callback passed to this method is allowed to do.

+
const collection = db.collection(collectionName);
const trx = db.transaction(transactionId);

// WARNING: This code will not work as intended!
await trx.step(async () => {
await collection.save(doc1);
await collection.save(doc2); // Not part of the transaction!
});

// INSTEAD: Always perform a single operation per step:
await trx.step(() => collection.save(doc1));
await trx.step(() => collection.save(doc2)); +
+

Please refer to the documentation of this method for additional examples.

+

Streaming transactions timeout in cluster

Example messages: transaction not found, transaction already expired.

+

Transactions have +different guarantees +in a cluster.

+

When using arangojs in a cluster with load balancing, you may need to adjust +the value of config.poolSize to accommodate the number of transactions +you need to be able to run in parallel. The default value is likely to be too +low for most cluster scenarios involving frequent streaming transactions.

+

Note: When using a high value for config.poolSize you may have +to adjust the maximum number of threads in the ArangoDB configuration using +the server.maximal-threads option +to support larger numbers of concurrent transactions on the server side.

+

License

The Apache License, Version 2.0. For more information, see the accompanying +LICENSE file.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/aql.AqlLiteral.html b/9.0.0-preview.1/interfaces/aql.AqlLiteral.html new file mode 100644 index 000000000..b5bad7bb6 --- /dev/null +++ b/9.0.0-preview.1/interfaces/aql.AqlLiteral.html @@ -0,0 +1,5 @@ +AqlLiteral | arangojs - v9.0.0-preview.1

Interface AqlLiteral

An object representing a trusted AQL literal that will be inlined directly +when used in an AQL template or passed to AQL helper functions.

+

Arbitrary values can be converted to trusted AQL literals by passing them +to the literal helper function.

+
interface AqlLiteral {}
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/aql.AqlQuery.html b/9.0.0-preview.1/interfaces/aql.AqlQuery.html new file mode 100644 index 000000000..232745bb6 --- /dev/null +++ b/9.0.0-preview.1/interfaces/aql.AqlQuery.html @@ -0,0 +1,10 @@ +AqlQuery | arangojs - v9.0.0-preview.1

Interface AqlQuery<T>

Generic AQL query object consisting of an AQL query string and its bind +parameters.

+
interface AqlQuery<T> {
    [type]?: any;
    bindVars: Record<string, any>;
    query: string;
}

Type Parameters

  • T = any

Properties

Properties

[type]?: any
bindVars: Record<string, any>

An object mapping AQL bind parameter names to their respective values.

+

Names of parameters representing collections are prefixed with an +at-symbol.

+
query: string

An AQL query string.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/collection.ArangoCollection.html b/9.0.0-preview.1/interfaces/collection.ArangoCollection.html new file mode 100644 index 000000000..fdc0c6e0b --- /dev/null +++ b/9.0.0-preview.1/interfaces/collection.ArangoCollection.html @@ -0,0 +1,6 @@ +ArangoCollection | arangojs - v9.0.0-preview.1

Interface ArangoCollection

A marker interface identifying objects that can be used in AQL template +strings to create references to ArangoDB collections.

+

See aql!aql.

+
interface ArangoCollection {
    name: string;
}

Hierarchy (view full)

Implemented by

Properties

Properties

name: string

Name of the collection.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/collection.DocumentCollection.html b/9.0.0-preview.1/interfaces/collection.DocumentCollection.html new file mode 100644 index 000000000..b806b8943 --- /dev/null +++ b/9.0.0-preview.1/interfaces/collection.DocumentCollection.html @@ -0,0 +1,373 @@ +DocumentCollection | arangojs - v9.0.0-preview.1

Interface DocumentCollection<T>

Represents an document collection in a database.Database.

+

See EdgeCollection for a variant of this interface more suited for +edge collections.

+

When using TypeScript, collections can be cast to a specific document data +type to increase type safety.

+

Example

interface Person {
name: string;
}
const db = new Database();
const documents = db.collection("persons") as DocumentCollection<Person>; +
+
interface DocumentCollection<T> {
    name: string;
    all(options?): Promise<ArrayCursor<Document<T>>>;
    any(): Promise<Document<T>>;
    byExample(example, options?): Promise<ArrayCursor<Document<T>>>;
    checksum(options?): Promise<ArangoApiResponse<CollectionMetadata & {
        checksum: string;
        revision: string;
    }>>;
    compact(): Promise<ArangoApiResponse<Record<string, never>>>;
    count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
    }>>;
    create(options?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    document(selector, options?): Promise<Document<T>>;
    document(selector, graceful): Promise<Document<T>>;
    documentExists(selector, options?): Promise<boolean>;
    documentId(selector): string;
    documents(selectors, options?): Promise<Document<T>[]>;
    drop(options?): Promise<ArangoApiResponse<Record<string, never>>>;
    dropIndex(selector): Promise<ArangoApiResponse<{
        id: string;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    exists(): Promise<boolean>;
    figures(details?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>;
    firstExample(example): Promise<Document<T>>;
    fulltext(attribute, query, options?): Promise<ArrayCursor<Document<T>>>;
    get(): Promise<ArangoApiResponse<CollectionMetadata>>;
    getResponsibleShard(document): Promise<string>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    index(selector): Promise<Index>;
    indexes(): Promise<Index[]>;
    list(type?): Promise<ArrayCursor<string>>;
    loadIndexes(): Promise<boolean>;
    lookupByKeys(keys): Promise<Document<T>[]>;
    properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    properties(properties): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    recalculateCount(): Promise<boolean>;
    remove(selector, options?): Promise<DocumentMetadata & {
        old?: Document<T>;
    }>;
    removeAll(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        old?: Document<T>;
    })[]>;
    removeByExample(example, options?): Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>;
    removeByKeys(keys, options?): Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>;
    rename(newName): Promise<ArangoApiResponse<CollectionMetadata>>;
    replace(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>;
    replaceAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>;
    replaceByExample(example, newValue, options?): Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>;
    revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        revision: string;
    }>>;
    save(data, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>;
    saveAll(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>;
    truncate(): Promise<ArangoApiResponse<CollectionMetadata>>;
    update(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>;
    updateAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>;
    updateByExample(example, newValue, options?): Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>;
}

Type Parameters

  • T extends Record<string, any> = any

    Type to use for document data. Defaults to any.

    +

Hierarchy (view full)

Properties

name: string

Name of the collection.

+

Methods

  • Retrieves all documents in the collection.

    +

    Parameters

    Returns Promise<ArrayCursor<Document<T>>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.all();
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc
    `); +
    +
  • Retrieves a random document from the collection.

    +

    Returns Promise<Document<T>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const doc = await collection.any();
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    SORT RAND()
    LIMIT 1
    RETURN doc
    `);
    const doc = await cursor.next(); +
    +
  • Retrieves all documents in the collection matching the given example.

    +

    Parameters

    Returns Promise<ArrayCursor<Document<T>>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.byExample({ flavor: "strawberry" });
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc
    `); +
    +
  • Retrieves the collection checksum.

    +

    Parameters

    Returns Promise<ArangoApiResponse<CollectionMetadata & {
        checksum: string;
        revision: string;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const data = await collection.checksum();
    // data contains the collection's checksum +
    +
  • Triggers compaction for a collection.

    +

    Returns Promise<ArangoApiResponse<Record<string, never>>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.compact();
    // Background compaction is triggered on the collection +
    +
  • Creates a collection with the given options and the instance's name.

    +

    See also database.Database#createCollection and +database.Database#createEdgeCollection.

    +

    Note: When called on an EdgeCollection instance in TypeScript, +the type option must still be set to the correct CollectionType. +Otherwise this will result in the collection being created with the +default type (i.e. as a document collection).

    +

    Parameters

    Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>

    Example

    const db = new Database();
    const collection = db.collection("potatoes");
    await collection.create();
    // the document collection "potatoes" now exists +
    +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.create({ type: CollectionType.EDGE_COLLECTION });
    // the edge collection "friends" now exists +
    +

    Example

    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const collection = db.collection("friends") as EdgeCollection<Friend>;
    // even in TypeScript you still need to indicate the collection type
    // if you want to create an edge collection
    await collection.create({ type: CollectionType.EDGE_COLLECTION });
    // the edge collection "friends" now exists +
    +
  • Retrieves the document matching the given key or id.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • Optional options: CollectionReadOptions

      Options for retrieving the document.

      +

    Returns Promise<Document<T>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const document = await collection.document("abc123");
    console.log(document);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const document = await collection.document("abc123", { graceful: true });
    if (document) {
    console.log(document);
    } else {
    console.error("Could not find document");
    } +
    +
  • Retrieves the document matching the given key or id.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • graceful: boolean

      If set to true, null is returned instead of an +exception being thrown if the document does not exist.

      +

    Returns Promise<Document<T>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const document = await collection.document("abc123", false);
    console.log(document);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const document = await collection.document("abc123", true);
    if (document) {
    console.log(document);
    } else {
    console.error("Could not find document");
    } +
    +
  • Checks whether a document matching the given key or id exists in this +collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    Returns Promise<boolean>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const exists = await collection.documentExists("abc123");
    if (!exists) {
    console.log("Document does not exist");
    } +
    +
  • Derives a document _id from the given selector for this collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +

    Returns string

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const meta = await collection.save({ foo: "bar" }, { returnNew: true });
    const doc = meta.new;
    console.log(collection.documentId(meta)); // via meta._id
    console.log(collection.documentId(doc)); // via doc._id
    console.log(collection.documentId(meta._key)); // also works +
    +

    Example

    const db = new Database();
    const collection1 = db.collection("some-collection");
    const collection2 = db.collection("other-collection");
    const meta = await collection1.save({ foo: "bar" });
    // Mixing collections is usually a mistake
    console.log(collection1.documentId(meta)); // ok: same collection
    console.log(collection2.documentId(meta)); // throws: wrong collection
    console.log(collection2.documentId(meta._id)); // also throws
    console.log(collection2.documentId(meta._key)); // ok but wrong collection +
    +
  • Retrieves the documents matching the given key or id values.

    +

    Throws an exception when passed a document or _id from a different +collection, or if the document does not exist.

    +

    Parameters

    • selectors: (string | ObjectWithKey)[]

      Array of document _key, _id or objects with either +of those properties (e.g. a document from this collection).

      +
    • Optional options: CollectionBatchReadOptions

      Options for retrieving the documents.

      +

    Returns Promise<Document<T>[]>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const documents = await collection.documents(["abc123", "xyz456"]);
    console.log(documents);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    +
  • Deletes the collection from the database.

    +

    Parameters

    Returns Promise<ArangoApiResponse<Record<string, never>>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.drop();
    // The collection "some-collection" is now an ex-collection +
    +
  • Deletes the index with the given name or id from the database.

    +

    Parameters

    • selector: IndexSelector

      Index name, id or object with either property.

      +

    Returns Promise<ArangoApiResponse<{
        id: string;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.dropIndex("some-index");
    // The index "some-index" no longer exists +
    +
  • Creates a persistent index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create a unique index for looking up documents by username
    await collection.ensureIndex({
    type: "persistent",
    fields: ["username"],
    name: "unique-usernames",
    unique: true
    }); +
    +
  • Creates a TTL index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Expire documents with "createdAt" timestamp one day after creation
    await collection.ensureIndex({
    type: "ttl",
    fields: ["createdAt"],
    expireAfter: 60 * 60 * 24 // 24 hours
    }); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Expire documents with "expiresAt" timestamp according to their value
    await collection.ensureIndex({
    type: "ttl",
    fields: ["expiresAt"],
    expireAfter: 0 // when attribute value is exceeded
    }); +
    +
  • Creates a multi-dimensional index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-points");
    // Create a multi-dimensional index for the attributes x, y and z
    await collection.ensureIndex({
    type: "mdi",
    fields: ["x", "y", "z"],
    fieldValueTypes: "double"
    }); +
    +
    
    +
    +
  • Creates a geo index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create an index for GeoJSON data
    await collection.ensureIndex({
    type: "geo",
    fields: ["lngLat"],
    geoJson: true
    }); +
    +
  • Creates a inverted index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create an inverted index
    await collection.ensureIndex({
    type: "inverted",
    fields: ["a", { name: "b", analyzer: "text_en" }]
    }); +
    +
  • Checks whether the collection exists.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const result = await collection.exists();
    // result indicates whether the collection exists +
    +
  • Retrieves statistics for a collection.

    +

    Parameters

    • Optional details: boolean

      whether to return extended storage engine-specific details +to the figures, which may cause additional load and impact performance

      +

    Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const data = await collection.figures();
    // data contains the collection's figures +
    +
  • Retrieves a single document in the collection matching the given example.

    +

    Parameters

    • example: Partial<DocumentData<T>>

      An object representing an example for the document.

      +

    Returns Promise<Document<T>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const doc = await collection.firstExample({ flavor: "strawberry" });
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    LIMIT 1
    RETURN doc
    `);
    const doc = await cursor.next(); +
    +
  • Performs a fulltext query in the given attribute on the collection.

    +

    Parameters

    • attribute: string

      Name of the field to search.

      +
    • query: string

      Fulltext query string to search for.

      +
    • Optional options: SimpleQueryFulltextOptions

      Options for performing the fulltext query.

      +

    Returns Promise<ArrayCursor<Document<T>>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.fulltext("article", "needle");
    const cursor = await db.query(aql`
    FOR doc IN FULLTEXT(${collection}, "article", "needle")
    RETURN doc
    `); +
    +
  • Retrieves the shardId of the shard responsible for the given document.

    +

    Parameters

    • document: Partial<Document<T>>

      Document in the collection to look up the shardId of.

      +

    Returns Promise<string>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const responsibleShard = await collection.getResponsibleShard(); +
    +
  • Bulk imports the given data into the collection.

    +

    Parameters

    Returns Promise<CollectionImportResult>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    [
    { _key: "jcd", password: "bionicman" },
    { _key: "jreyes", password: "amigo" },
    { _key: "ghermann", password: "zeitgeist" }
    ]
    ); +
    +
  • Bulk imports the given data into the collection.

    +

    Parameters

    • data: any[][]

      The data to import, as an array containing a single array of +attribute names followed by one or more arrays of attribute values for +each document.

      +
    • Optional options: CollectionImportOptions

      Options for importing the data.

      +

    Returns Promise<CollectionImportResult>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    [
    [ "_key", "password" ],
    [ "jcd", "bionicman" ],
    [ "jreyes", "amigo" ],
    [ "ghermann", "zeitgeist" ]
    ]
    ); +
    +
  • Bulk imports the given data into the collection.

    +

    If type is omitted, data must contain one JSON array per line with +the first array providing the attribute names and all other arrays +providing attribute values for each document.

    +

    If type is set to "documents", data must contain one JSON document +per line.

    +

    If type is set to "list", data must contain a JSON array of +documents.

    +

    If type is set to "auto", data can be in either of the formats +supported by "documents" or "list".

    +

    Parameters

    • data: string | Buffer | Blob

      The data to import as a Buffer (Node), Blob (browser) or +string.

      +
    • Optional options: CollectionImportOptions & {
          type?: "documents" | "list" | "auto";
      }

      Options for importing the data.

      +

    Returns Promise<CollectionImportResult>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '{"_key":"jcd","password":"bionicman"}\r\n' +
    '{"_key":"jreyes","password":"amigo"}\r\n' +
    '{"_key":"ghermann","password":"zeitgeist"}\r\n',
    { type: "documents" } // or "auto"
    ); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '[{"_key":"jcd","password":"bionicman"},' +
    '{"_key":"jreyes","password":"amigo"},' +
    '{"_key":"ghermann","password":"zeitgeist"}]',
    { type: "list" } // or "auto"
    ); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '["_key","password"]\r\n' +
    '["jcd","bionicman"]\r\n' +
    '["jreyes","amigo"]\r\n' +
    '["ghermann","zeitgeist"]\r\n'
    ); +
    +
  • Returns an index description by name or id if it exists.

    +

    Parameters

    • selector: IndexSelector

      Index name, id or object with either property.

      +

    Returns Promise<Index>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const index = await collection.index("some-index"); +
    +
  • Returns a list of all index descriptions for the collection.

    +

    Returns Promise<Index[]>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const indexes = await collection.indexes(); +
    +
  • Retrieves a list of references for all documents in the collection.

    +

    Parameters

    Returns Promise<ArrayCursor<string>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const ids = await collection.list("id");
    const ids = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc._id
    `); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const keys = await collection.list("key");
    const keys = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc._key
    `); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const paths = await collection.list("path");
    const paths = await db.query(aql`
    FOR doc IN ${collection}
    RETURN CONCAT("/_db/", CURRENT_DATABASE(), "/_api/document/", doc._id)
    `); +
    +
  • (RocksDB only.) Instructs ArangoDB to load as many indexes of the +collection into memory as permitted by the memory limit.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const collection = db.collection("indexed-collection");
    await collection.loadIndexes();
    // the indexes are now loaded into memory +
    +
  • Retrieves all documents matching the given document keys.

    +

    Parameters

    • keys: string[]

      An array of document keys to look up.

      +

    Returns Promise<Document<T>[]>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const keys = ["a", "b", "c"];
    // const docs = await collection.byKeys(keys);
    const cursor = await db.query(aql`
    FOR key IN ${keys}
    LET doc = DOCUMENT(${collection}, key)
    RETURN doc
    `);
    const docs = await cursor.all(); +
    +
  • (RocksDB only.) Instructs ArangoDB to recalculate the collection's +document count to fix any inconsistencies.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const collection = db.collection("inconsistent-collection");
    const badData = await collection.count();
    // oh no, the collection count looks wrong -- fix it!
    await collection.recalculateCount();
    const goodData = await collection.count();
    // goodData contains the collection's improved count +
    +
  • Removes an existing document from the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • Optional options: CollectionRemoveOptions

      Options for removing the document.

      +

    Returns Promise<DocumentMetadata & {
        old?: Document<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.remove("abc123");
    // document with key "abc123" deleted +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const doc = await collection.document("abc123");
    await collection.remove(doc);
    // document with key "abc123" deleted +
    +
  • Removes existing documents from the collection.

    +

    Throws an exception when passed any document or _id from a different +collection.

    +

    Parameters

    • selectors: (string | ObjectWithKey)[]

      Documents _key, _id or objects with either of those +properties (e.g. documents from this collection).

      +
    • Optional options: Omit<CollectionRemoveOptions, "ifMatch">

      Options for removing the documents.

      +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        old?: Document<T>;
    })[]>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.removeAll(["abc123", "def456"]);
    // document with keys "abc123" and "def456" deleted +
    +
  • Removes all documents in the collection matching the given example.

    +

    Parameters

    Returns Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const { deleted } = await collection.removeByExample({
    // flavor: "strawberry"
    // });
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    REMOVE doc IN ${collection}
    RETURN 1
    )
    `);
    const deleted = await cursor.next(); +
    +
  • Removes all documents matching the given document keys.

    +

    Parameters

    Returns Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const keys = ["a", "b", "c"];
    // const { removed, ignored } = await collection.removeByKeys(keys);
    const cursor = await db.query(aql`
    FOR key IN ${keys}
    LET doc = DOCUMENT(${collection}, key)
    FILTER doc
    REMOVE doc IN ${collection}
    RETURN key
    `);
    const removed = await cursor.all();
    const ignored = keys.filter((key) => !removed.includes(key)); +
    +
  • Renames the collection and updates the instance's name to newName.

    +

    Additionally removes the instance from the database.Database's internal +cache.

    +

    Note: Renaming collections may not be supported when ArangoDB is +running in a cluster configuration.

    +

    Parameters

    • newName: string

      The new name of the collection.

      +

    Returns Promise<ArangoApiResponse<CollectionMetadata>>

    Example

    const db = new Database();
    const collection1 = db.collection("some-collection");
    await collection1.rename("other-collection");
    const collection2 = db.collection("some-collection");
    const collection3 = db.collection("other-collection");
    // Note all three collection instances are different objects but
    // collection1 and collection3 represent the same ArangoDB collection! +
    +
  • Replaces an existing document in the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • newData: DocumentData<T>

      The contents of the new document.

      +
    • Optional options: CollectionReplaceOptions

      Options for replacing the document.

      +

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    const result = await collection.replace(
    "a",
    { color: "red" },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "red" undefined +
    +
  • Replaces existing documents in the collection, identified by the _key or +_id of each document.

    +

    Parameters

    • newData: (T & Partial<DocumentMetadata> & (Partial<EdgeMetadata> & ({ _key: string; } | { _id: string; })))[]

      The documents to replace.

      +
    • Optional options: Omit<CollectionReplaceOptions, "ifMatch">

      Options for replacing the documents.

      +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    await collection.save({ _key: "b", color: "green", count: 3 });
    const result = await collection.replaceAll(
    [
    { _key: "a", color: "red" },
    { _key: "b", color: "yellow", count: 2 }
    ],
    { returnNew: true }
    );
    console.log(result[0].new.color, result[0].new.count); // "red" undefined
    console.log(result[1].new.color, result[1].new.count); // "yellow" 2 +
    +
  • Replaces all documents in the collection matching the given example.

    +

    Parameters

    Returns Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const newValue = { flavor: "chocolate" };
    // const { replaced } = await collection.replaceByExample(
    // { flavor: "strawberry" },
    // newValue
    // );
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    REPLACE doc WITH ${newValue} IN ${collection}
    RETURN 1
    )
    `);
    const replaced = await cursor.next(); +
    +
  • Inserts a new document with the given data into the collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const result = await collection.save(
    { _key: "a", color: "blue", count: 1 },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "blue" 1 +
    +
  • Inserts new documents with the given data into the collection.

    +

    Parameters

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const result = await collection.saveAll(
    [
    { _key: "a", color: "blue", count: 1 },
    { _key: "b", color: "red", count: 2 },
    ],
    { returnNew: true }
    );
    console.log(result[0].new.color, result[0].new.count); // "blue" 1
    console.log(result[1].new.color, result[1].new.count); // "red" 2 +
    +
  • Updates an existing document in the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    const result = await collection.update(
    "a",
    { count: 2 },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "blue" 2 +
    +
  • Updates existing documents in the collection, identified by the _key or +_id of each document.

    +

    Parameters

    • newData: (Patch<DocumentData<T>> & ({
          _key: string;
      } | {
          _id: string;
      }))[]

      The data for updating the documents.

      +
    • Optional options: Omit<CollectionUpdateOptions, "ifMatch">

      Options for updating the documents.

      +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    await collection.save({ _key: "b", color: "green", count: 3 });
    const result = await collection.updateAll(
    [
    { _key: "a", count: 2 },
    { _key: "b", count: 4 }
    ],
    { returnNew: true }
    );
    console.log(result[0].new.color, result[0].new.count); // "blue" 2
    console.log(result[1].new.color, result[1].new.count); // "green" 4 +
    +
  • Updates all documents in the collection matching the given example.

    +

    Parameters

    Returns Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const newData = { color: "red" };
    // const { updated } = await collection.updateByExample(
    // { flavor: "strawberry" },
    // newValue
    // );
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    UPDATE doc WITH ${newValue} IN ${collection}
    RETURN 1
    )
    `);
    const updated = await cursor.next(); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/collection.EdgeCollection.html b/9.0.0-preview.1/interfaces/collection.EdgeCollection.html new file mode 100644 index 000000000..8ad5bd032 --- /dev/null +++ b/9.0.0-preview.1/interfaces/collection.EdgeCollection.html @@ -0,0 +1,416 @@ +EdgeCollection | arangojs - v9.0.0-preview.1

Interface EdgeCollection<T>

Represents an edge collection in a database.Database.

+

See DocumentCollection for a more generic variant of this interface +more suited for regular document collections.

+

See also graph.GraphEdgeCollection for the type representing an edge +collection in a graph.Graph.

+

When using TypeScript, collections can be cast to a specific edge document +data type to increase type safety.

+

Example

interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const edges = db.collection("friends") as EdgeCollection<Friend>; +
+
interface EdgeCollection<T> {
    name: string;
    all(options?): Promise<ArrayCursor<Edge<T>>>;
    any(): Promise<Edge<T>>;
    byExample(example, options?): Promise<ArrayCursor<Edge<T>>>;
    checksum(options?): Promise<ArangoApiResponse<CollectionMetadata & {
        checksum: string;
        revision: string;
    }>>;
    compact(): Promise<ArangoApiResponse<Record<string, never>>>;
    count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
    }>>;
    create(options?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    document(selector, options?): Promise<Edge<T>>;
    document(selector, graceful): Promise<Edge<T>>;
    documentExists(selector, options?): Promise<boolean>;
    documentId(selector): string;
    documents(selectors, options?): Promise<Edge<T>[]>;
    drop(options?): Promise<ArangoApiResponse<Record<string, never>>>;
    dropIndex(selector): Promise<ArangoApiResponse<{
        id: string;
    }>>;
    edges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    exists(): Promise<boolean>;
    figures(details?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>;
    firstExample(example): Promise<Edge<T>>;
    fulltext(attribute, query, options?): Promise<ArrayCursor<Edge<T>>>;
    get(): Promise<ArangoApiResponse<CollectionMetadata>>;
    getResponsibleShard(document): Promise<string>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    inEdges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
    index(selector): Promise<Index>;
    indexes(): Promise<Index[]>;
    list(type?): Promise<ArrayCursor<string>>;
    loadIndexes(): Promise<boolean>;
    lookupByKeys(keys): Promise<Edge<T>[]>;
    outEdges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
    properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    properties(properties): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    recalculateCount(): Promise<boolean>;
    remove(selector, options?): Promise<DocumentMetadata & {
        old?: Edge<T>;
    }>;
    removeAll(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        old?: Edge<T>;
    })[]>;
    removeByExample(example, options?): Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>;
    removeByKeys(keys, options?): Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>;
    rename(newName): Promise<ArangoApiResponse<CollectionMetadata>>;
    replace(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>;
    replaceAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    })[]>;
    replaceByExample(example, newValue, options?): Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>;
    revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        revision: string;
    }>>;
    save(data, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>;
    saveAll(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    })[]>;
    traversal(startVertex, options?): Promise<any>;
    truncate(): Promise<ArangoApiResponse<CollectionMetadata>>;
    update(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>;
    updateAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    })[]>;
    updateByExample(example, newValue, options?): Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>;
}

Type Parameters

  • T extends Record<string, any> = any

    Type to use for edge document data. Defaults to any.

    +

Hierarchy (view full)

Properties

name: string

Name of the collection.

+

Methods

  • Retrieves all documents in the collection.

    +

    Parameters

    Returns Promise<ArrayCursor<Edge<T>>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.all();
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc
    `); +
    +
  • Retrieves a random document from the collection.

    +

    Returns Promise<Edge<T>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const doc = await collection.any();
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    SORT RAND()
    LIMIT 1
    RETURN doc
    `);
    const doc = await cursor.next(); +
    +
  • Retrieves all documents in the collection matching the given example.

    +

    Parameters

    Returns Promise<ArrayCursor<Edge<T>>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.byExample({ flavor: "strawberry" });
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc
    `); +
    +
  • Triggers compaction for a collection.

    +

    Returns Promise<ArangoApiResponse<Record<string, never>>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.compact();
    // Background compaction is triggered on the collection +
    +
  • Creates a collection with the given options and the instance's name.

    +

    See also database.Database#createCollection and +database.Database#createEdgeCollection.

    +

    Note: When called on an EdgeCollection instance in TypeScript, +the type option must still be set to the correct CollectionType. +Otherwise this will result in the collection being created with the +default type (i.e. as a document collection).

    +

    Parameters

    Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>

    Example

    const db = new Database();
    const collection = db.collection("potatoes");
    await collection.create();
    // the document collection "potatoes" now exists +
    +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.create({ type: CollectionType.EDGE_COLLECTION });
    // the edge collection "friends" now exists +
    +

    Example

    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const collection = db.collection("friends") as EdgeCollection<Friend>;
    // even in TypeScript you still need to indicate the collection type
    // if you want to create an edge collection
    await collection.create({ type: CollectionType.EDGE_COLLECTION });
    // the edge collection "friends" now exists +
    +
  • Retrieves the document matching the given key or id.

    +

    Throws an exception when passed a document or _id from a different +collection, or if the document does not exist.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • Optional options: CollectionReadOptions

      Options for retrieving the document.

      +

    Returns Promise<Edge<T>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const document = await collection.document("abc123");
    console.log(document);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const document = await collection.document("abc123", { graceful: true });
    if (document) {
    console.log(document);
    } else {
    console.error("Document does not exist");
    } +
    +
  • Retrieves the document matching the given key or id.

    +

    Throws an exception when passed a document or _id from a different +collection, or if the document does not exist.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • graceful: boolean

      If set to true, null is returned instead of an +exception being thrown if the document does not exist.

      +

    Returns Promise<Edge<T>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const document = await collection.document("abc123", false);
    console.log(document);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const document = await collection.document("abc123", true);
    if (document) {
    console.log(document);
    } else {
    console.error("Document does not exist");
    } +
    +
  • Checks whether a document matching the given key or id exists in this +collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    Returns Promise<boolean>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const exists = await collection.documentExists("abc123");
    if (!exists) {
    console.log("Document does not exist");
    } +
    +
  • Derives a document _id from the given selector for this collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +

    Returns string

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const meta = await collection.save({ foo: "bar" }, { returnNew: true });
    const doc = meta.new;
    console.log(collection.documentId(meta)); // via meta._id
    console.log(collection.documentId(doc)); // via doc._id
    console.log(collection.documentId(meta._key)); // also works +
    +

    Example

    const db = new Database();
    const collection1 = db.collection("some-collection");
    const collection2 = db.collection("other-collection");
    const meta = await collection1.save({ foo: "bar" });
    // Mixing collections is usually a mistake
    console.log(collection1.documentId(meta)); // ok: same collection
    console.log(collection2.documentId(meta)); // throws: wrong collection
    console.log(collection2.documentId(meta._id)); // also throws
    console.log(collection2.documentId(meta._key)); // ok but wrong collection +
    +
  • Retrieves the documents matching the given key or id values.

    +

    Throws an exception when passed a document or _id from a different +collection, or if the document does not exist.

    +

    Parameters

    • selectors: (string | ObjectWithKey)[]

      Array of document _key, _id or objects with either +of those properties (e.g. a document from this collection).

      +
    • Optional options: CollectionBatchReadOptions

      Options for retrieving the documents.

      +

    Returns Promise<Edge<T>[]>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const documents = await collection.documents(["abc123", "xyz456"]);
    console.log(documents);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    +
  • Deletes the collection from the database.

    +

    Parameters

    Returns Promise<ArangoApiResponse<Record<string, never>>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.drop();
    // The collection "some-collection" is now an ex-collection +
    +
  • Deletes the index with the given name or id from the database.

    +

    Parameters

    • selector: IndexSelector

      Index name, id or object with either property.

      +

    Returns Promise<ArangoApiResponse<{
        id: string;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.dropIndex("some-index");
    // The index "some-index" no longer exists +
    +
  • Retrieves a list of all edges of the document matching the given +selector.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • Optional options: CollectionEdgesOptions

      Options for retrieving the edges.

      +

    Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>

    Example

    const db = new Database();
    const collection = db.collection("edges");
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/a", "vertices/c"],
    ["z", "vertices/d", "vertices/a"],
    ]);
    const edges = await collection.edges("vertices/a");
    console.log(edges.map((edge) => edge._key)); // ["x", "y", "z"] +
    +
  • Creates a persistent index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create a unique index for looking up documents by username
    await collection.ensureIndex({
    type: "persistent",
    fields: ["username"],
    name: "unique-usernames",
    unique: true
    }); +
    +
  • Creates a TTL index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Expire documents with "createdAt" timestamp one day after creation
    await collection.ensureIndex({
    type: "ttl",
    fields: ["createdAt"],
    expireAfter: 60 * 60 * 24 // 24 hours
    }); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Expire documents with "expiresAt" timestamp according to their value
    await collection.ensureIndex({
    type: "ttl",
    fields: ["expiresAt"],
    expireAfter: 0 // when attribute value is exceeded
    }); +
    +
  • Creates a multi-dimensional index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-points");
    // Create a multi-dimensional index for the attributes x, y and z
    await collection.ensureIndex({
    type: "mdi",
    fields: ["x", "y", "z"],
    fieldValueTypes: "double"
    }); +
    +
    
    +
    +
  • Creates a geo index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create an index for GeoJSON data
    await collection.ensureIndex({
    type: "geo",
    fields: ["lngLat"],
    geoJson: true
    }); +
    +
  • Creates a inverted index on the collection if it does not already exist.

    +

    Parameters

    Returns Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create an inverted index
    await collection.ensureIndex({
    type: "inverted",
    fields: ["a", { name: "b", analyzer: "text_en" }]
    }); +
    +
  • Checks whether the collection exists.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const result = await collection.exists();
    // result indicates whether the collection exists +
    +
  • Retrieves a single document in the collection matching the given example.

    +

    Parameters

    • example: Partial<DocumentData<T>>

      An object representing an example for the document.

      +

    Returns Promise<Edge<T>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const doc = await collection.firstExample({ flavor: "strawberry" });
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    LIMIT 1
    RETURN doc
    `);
    const doc = await cursor.next(); +
    +
  • Performs a fulltext query in the given attribute on the collection.

    +

    Parameters

    • attribute: string

      Name of the field to search.

      +
    • query: string

      Fulltext query string to search for.

      +
    • Optional options: SimpleQueryFulltextOptions

      Options for performing the fulltext query.

      +

    Returns Promise<ArrayCursor<Edge<T>>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.fulltext("article", "needle");
    const cursor = await db.query(aql`
    FOR doc IN FULLTEXT(${collection}, "article", "needle")
    RETURN doc
    `); +
    +
  • Retrieves the shardId of the shard responsible for the given document.

    +

    Parameters

    • document: Partial<Document<T>>

      Document in the collection to look up the shardId of.

      +

    Returns Promise<string>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const responsibleShard = await collection.getResponsibleShard(); +
    +
  • Bulk imports the given data into the collection.

    +

    Parameters

    Returns Promise<CollectionImportResult>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    [
    { _key: "x", _from: "vertices/a", _to: "vertices/b", weight: 1 },
    { _key: "y", _from: "vertices/a", _to: "vertices/c", weight: 2 }
    ]
    ); +
    +
  • Bulk imports the given data into the collection.

    +

    Parameters

    • data: any[][]

      The data to import, as an array containing a single array of +attribute names followed by one or more arrays of attribute values for +each edge document.

      +
    • Optional options: CollectionImportOptions

      Options for importing the data.

      +

    Returns Promise<CollectionImportResult>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    [
    [ "_key", "_from", "_to", "weight" ],
    [ "x", "vertices/a", "vertices/b", 1 ],
    [ "y", "vertices/a", "vertices/c", 2 ]
    ]
    ); +
    +
  • Bulk imports the given data into the collection.

    +

    If type is omitted, data must contain one JSON array per line with +the first array providing the attribute names and all other arrays +providing attribute values for each edge document.

    +

    If type is set to "documents", data must contain one JSON document +per line.

    +

    If type is set to "list", data must contain a JSON array of +edge documents.

    +

    If type is set to "auto", data can be in either of the formats +supported by "documents" or "list".

    +

    Parameters

    • data: string | Buffer | Blob

      The data to import as a Buffer (Node), Blob (browser) or +string.

      +
    • Optional options: CollectionImportOptions & {
          type?: "documents" | "list" | "auto";
      }

      Options for importing the data.

      +

    Returns Promise<CollectionImportResult>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '{"_key":"x","_from":"vertices/a","_to":"vertices/b","weight":1}\r\n' +
    '{"_key":"y","_from":"vertices/a","_to":"vertices/c","weight":2}\r\n',
    { type: "documents" } // or "auto"
    ); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '[{"_key":"x","_from":"vertices/a","_to":"vertices/b","weight":1},' +
    '{"_key":"y","_from":"vertices/a","_to":"vertices/c","weight":2}]',
    { type: "list" } // or "auto"
    ); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '["_key","_from","_to","weight"]\r\n' +
    '["x","vertices/a","vertices/b",1]\r\n' +
    '["y","vertices/a","vertices/c",2]\r\n'
    ); +
    +
  • Retrieves a list of all incoming edges of the document matching the given +selector.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • Optional options: CollectionEdgesOptions

      Options for retrieving the edges.

      +

    Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>

    Example

    const db = new Database();
    const collection = db.collection("edges");
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/a", "vertices/c"],
    ["z", "vertices/d", "vertices/a"],
    ]);
    const edges = await collection.inEdges("vertices/a");
    console.log(edges.map((edge) => edge._key)); // ["z"] +
    +
  • Returns an index description by name or id if it exists.

    +

    Parameters

    • selector: IndexSelector

      Index name, id or object with either property.

      +

    Returns Promise<Index>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const index = await collection.index("some-index"); +
    +
  • Returns a list of all index descriptions for the collection.

    +

    Returns Promise<Index[]>

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const indexes = await collection.indexes(); +
    +
  • Retrieves a list of references for all documents in the collection.

    +

    Parameters

    Returns Promise<ArrayCursor<string>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const ids = await collection.list("id");
    const ids = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc._id
    `); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const keys = await collection.list("key");
    const keys = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc._key
    `); +
    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const paths = await collection.list("path");
    const paths = await db.query(aql`
    FOR doc IN ${collection}
    RETURN CONCAT("/_db/", CURRENT_DATABASE(), "/_api/document/", doc._id)
    `); +
    +
  • (RocksDB only.) Instructs ArangoDB to load as many indexes of the +collection into memory as permitted by the memory limit.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const collection = db.collection("indexed-collection");
    await collection.loadIndexes();
    // the indexes are now loaded into memory +
    +
  • Retrieves all documents matching the given document keys.

    +

    Parameters

    • keys: string[]

      An array of document keys to look up.

      +

    Returns Promise<Edge<T>[]>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const keys = ["a", "b", "c"];
    // const docs = await collection.byKeys(keys);
    const cursor = await db.query(aql`
    FOR key IN ${keys}
    LET doc = DOCUMENT(${collection}, key)
    RETURN doc
    `);
    const docs = await cursor.all(); +
    +
  • Retrieves a list of all outgoing edges of the document matching the given +selector.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • Optional options: CollectionEdgesOptions

      Options for retrieving the edges.

      +

    Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>

    Example

    const db = new Database();
    const collection = db.collection("edges");
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/a", "vertices/c"],
    ["z", "vertices/d", "vertices/a"],
    ]);
    const edges = await collection.outEdges("vertices/a");
    console.log(edges.map((edge) => edge._key)); // ["x", "y"] +
    +
  • (RocksDB only.) Instructs ArangoDB to recalculate the collection's +document count to fix any inconsistencies.

    +

    Returns Promise<boolean>

    Example

    const db = new Database();
    const collection = db.collection("inconsistent-collection");
    const badData = await collection.count();
    // oh no, the collection count looks wrong -- fix it!
    await collection.recalculateCount();
    const goodData = await collection.count();
    // goodData contains the collection's improved count +
    +
  • Removes an existing document from the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • Optional options: CollectionRemoveOptions

      Options for removing the document.

      +

    Returns Promise<DocumentMetadata & {
        old?: Edge<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const doc = await collection.document("musadir");
    await collection.remove(doc);
    // document with key "musadir" deleted +
    +
  • Removes all documents matching the given document keys.

    +

    Parameters

    Returns Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const keys = ["a", "b", "c"];
    // const { removed, ignored } = await collection.removeByKeys(keys);
    const cursor = await db.query(aql`
    FOR key IN ${keys}
    LET doc = DOCUMENT(${collection}, key)
    FILTER doc
    REMOVE doc IN ${collection}
    RETURN key
    `);
    const removed = await cursor.all();
    const ignored = keys.filter((key) => !removed.includes(key)); +
    +
  • Renames the collection and updates the instance's name to newName.

    +

    Additionally removes the instance from the database.Database's internal +cache.

    +

    Note: Renaming collections may not be supported when ArangoDB is +running in a cluster configuration.

    +

    Parameters

    • newName: string

      The new name of the collection.

      +

    Returns Promise<ArangoApiResponse<CollectionMetadata>>

    Example

    const db = new Database();
    const collection1 = db.collection("some-collection");
    await collection1.rename("other-collection");
    const collection2 = db.collection("some-collection");
    const collection3 = db.collection("other-collection");
    // Note all three collection instances are different objects but
    // collection1 and collection3 represent the same ArangoDB collection! +
    +
  • Replaces an existing document in the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    • selector: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • newData: DocumentData<T>

      The contents of the new document.

      +
    • Optional options: CollectionReplaceOptions

      Options for replacing the document.

      +

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    const result = await collection.replace(
    "musadir",
    { active: false },
    { returnNew: true }
    );
    console.log(result.new.active, result.new.best); // false undefined +
    +
  • Replaces existing documents in the collection, identified by the _key or +_id of each document.

    +

    Parameters

    • newData: (T & Partial<DocumentMetadata> & (Partial<EdgeMetadata> & ({ _key: string; } | { _id: string; })))[]

      The documents to replace.

      +
    • Optional options: CollectionReplaceOptions

      Options for replacing the documents.

      +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    })[]>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    await collection.save(
    {
    _key: "salman",
    _from: "users/rana",
    _to: "users/salman",
    active: false,
    best: false
    }
    );
    const result = await collection.replaceAll(
    [
    { _key: "musadir", active: false },
    { _key: "salman", active: true, best: true }
    ],
    { returnNew: true }
    );
    console.log(result[0].new.active, result[0].new.best); // false undefined
    console.log(result[1].new.active, result[1].new.best); // true true +
    +
  • Replaces all documents in the collection matching the given example.

    +

    Parameters

    Returns Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const newValue = { flavor: "chocolate" };
    // const { replaced } = await collection.replaceByExample(
    // { flavor: "strawberry" },
    // newValue
    // );
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    REPLACE doc WITH ${newValue} IN ${collection}
    RETURN 1
    )
    `);
    const replaced = await cursor.next(); +
    +
  • Inserts a new document with the given data into the collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const result = await collection.save(
    { _from: "users/rana", _to: "users/mudasir", active: false },
    { returnNew: true }
    ); +
    +
  • Performs a traversal starting from the given startVertex and following +edges contained in this edge collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    See also graph.Graph#traversal.

    +

    Parameters

    • startVertex: DocumentSelector

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • Optional options: TraversalOptions

      Options for performing the traversal.

      +

    Returns Promise<any>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and are +no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("edges");
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/b", "vertices/c"],
    ["z", "vertices/c", "vertices/d"],
    ]);
    const startVertex = "vertices/a";
    const cursor = await db.query(aql`
    FOR vertex IN OUTBOUND ${startVertex}
    RETURN vertex._key
    `);
    const result = await cursor.all();
    console.log(result); // ["a", "b", "c", "d"] +
    +
  • Updates an existing document in the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    Parameters

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    const result = await collection.update(
    "musadir",
    { active: false },
    { returnNew: true }
    );
    console.log(result.new.active, result.new.best); // false true +
    +
  • Updates existing documents in the collection, identified by the _key or +_id of each document.

    +

    Parameters

    • newData: (Patch<DocumentData<T>> & ({
          _key: string;
      } | {
          _id: string;
      }))[]

      The data for updating the documents.

      +
    • Optional options: CollectionUpdateOptions

      Options for updating the documents.

      +
      const db = new Database();
      const collection = db.collection("friends");
      await collection.save(
      {
      _key: "musadir",
      _from: "users/rana",
      _to: "users/mudasir",
      active: true,
      best: true
      }
      );
      await collection.save(
      {
      _key: "salman",
      _from: "users/rana",
      _to: "users/salman",
      active: false,
      best: false
      }
      );
      const result = await collection.updateAll(
      [
      { _key: "musadir", active: false },
      { _key: "salman", active: true, best: true }
      ],
      { returnNew: true }
      );
      console.log(result[0].new.active, result[0].new.best); // false true
      console.log(result[1].new.active, result[1].new.best); // true true +
      +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    })[]>

  • Updates all documents in the collection matching the given example.

    +

    Parameters

    Returns Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const newData = { color: "red" };
    // const { updated } = await collection.updateByExample(
    // { flavor: "strawberry" },
    // newValue
    // );
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    UPDATE doc WITH ${newValue} IN ${collection}
    RETURN 1
    )
    `);
    const updated = await cursor.next(); +
    +
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/cursor.CursorExtras.html b/9.0.0-preview.1/interfaces/cursor.CursorExtras.html new file mode 100644 index 000000000..904c73815 --- /dev/null +++ b/9.0.0-preview.1/interfaces/cursor.CursorExtras.html @@ -0,0 +1,10 @@ +CursorExtras | arangojs - v9.0.0-preview.1

Interface CursorExtras

Additional information about the cursor.

+
interface CursorExtras {
    plan?: Record<string, any>;
    profile?: Record<string, number>;
    stats?: CursorStats;
    warnings: {
        code: number;
        message: string;
    }[];
}

Properties

Properties

plan?: Record<string, any>

Query execution plan for the executed query.

+
profile?: Record<string, number>

Additional profiling information for the executed query.

+
stats?: CursorStats

Additional statistics about the query execution.

+
warnings: {
    code: number;
    message: string;
}[]

Warnings encountered while executing the query.

+

Type declaration

  • code: number
  • message: string
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/cursor.CursorStats.html b/9.0.0-preview.1/interfaces/cursor.CursorStats.html new file mode 100644 index 000000000..676902386 --- /dev/null +++ b/9.0.0-preview.1/interfaces/cursor.CursorStats.html @@ -0,0 +1,36 @@ +CursorStats | arangojs - v9.0.0-preview.1

Interface CursorStats

Additional statics about the query execution of the cursor.

+
interface CursorStats {
    cacheHits: number;
    cacheMisses: number;
    cursorsCreated: number;
    cursorsRearmed: number;
    executionTime: number;
    filtered: number;
    fullCount?: number;
    httpRequests: number;
    nodes?: {
        calls: number;
        filter: number;
        id: number;
        items: number;
        runtime: number;
    }[];
    peakMemoryUsage: number;
    scannedFull: number;
    scannedIndex: number;
    writesExecuted: number;
    writesIgnored: number;
}

Properties

cacheHits: number

Total number of index entries read from in-memory caches for indexes of +type edge or persistent.

+
cacheMisses: number

Total number of cache read attempts for index entries that could not be +served from in-memory caches for indexes of type edge or persistent.

+
cursorsCreated: number

Total number of cursor objects created during query execution.

+
cursorsRearmed: number

Total number of times an existing cursor object was repurposed.

+
executionTime: number

Execution time of the query in seconds.

+
filtered: number

Total number of documents that were removed after executing a filter condition in a FilterNode.

+
fullCount?: number

Total number of documents that matched the search condition if the query’s final top-level LIMIT statement were not present.

+
httpRequests: number

Total number of cluster-internal HTTP requests performed.

+
nodes?: {
    calls: number;
    filter: number;
    id: number;
    items: number;
    runtime: number;
}[]

Runtime statistics per query execution node if profile was set to 2 or greater.

+

Type declaration

  • calls: number

    Number of calls in this node.

    +
  • filter: number
  • id: number

    Execution node ID to correlate this node with nodes in the extra.plan.

    +
  • items: number

    Number of temporary result items returned by this node.

    +
  • runtime: number

    Execution time of this node in seconds.

    +
peakMemoryUsage: number

Maximum memory usage of the query while it was running.

+
scannedFull: number

Total number of documents iterated over when scanning a collection without an index.

+
scannedIndex: number

Total number of documents iterated over when scanning a collection using an index.

+
writesExecuted: number

Total number of data-modification operations successfully executed.

+
writesIgnored: number

Total number of data-modification operations that were unsuccessful, but have been ignored because of query option ignoreErrors.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/error.SystemError.html b/9.0.0-preview.1/interfaces/error.SystemError.html new file mode 100644 index 000000000..92ca021ad --- /dev/null +++ b/9.0.0-preview.1/interfaces/error.SystemError.html @@ -0,0 +1,5 @@ +SystemError | arangojs - v9.0.0-preview.1

Interface SystemError

Interface representing a Node.js SystemError.

+
interface SystemError {
    code: string;
    errno: string | number;
    syscall: string;
}

Hierarchy

  • Error
    • SystemError

Properties

Properties

code: string
errno: string | number
syscall: string
\ No newline at end of file diff --git a/9.0.0-preview.1/interfaces/view.ArangoSearchViewStoredValueOptions.html b/9.0.0-preview.1/interfaces/view.ArangoSearchViewStoredValueOptions.html new file mode 100644 index 000000000..0b05ad7d4 --- /dev/null +++ b/9.0.0-preview.1/interfaces/view.ArangoSearchViewStoredValueOptions.html @@ -0,0 +1,12 @@ +ArangoSearchViewStoredValueOptions | arangojs - v9.0.0-preview.1

Interface ArangoSearchViewStoredValueOptions

Options for creating a stored value in an ArangoSearch View.

+
interface ArangoSearchViewStoredValueOptions {
    cache?: boolean;
    compression?: Compression;
    fields: string[];
}

Properties

Properties

cache?: boolean

(Enterprise Edition only.) If set to true, then stored values will +always be cached in memory.

+

Default: false

+
compression?: Compression

How the attribute values should be compressed.

+

Default: "lz4"

+
fields: string[]

Attribute paths for which values should be stored in the view index +in addition to those used for sorting via primarySort.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/modules/analyzer.html b/9.0.0-preview.1/modules/analyzer.html new file mode 100644 index 000000000..0844b1ef6 --- /dev/null +++ b/9.0.0-preview.1/modules/analyzer.html @@ -0,0 +1,49 @@ +analyzer | arangojs - v9.0.0-preview.1
\ No newline at end of file diff --git a/9.0.0-preview.1/modules/aql.html b/9.0.0-preview.1/modules/aql.html new file mode 100644 index 000000000..0233a97c4 --- /dev/null +++ b/9.0.0-preview.1/modules/aql.html @@ -0,0 +1,14 @@ +aql | arangojs - v9.0.0-preview.1

Module aql

import { aql } from "arangojs/aql.js";
+
+

The "aql" module provides the aql template string handler and +helper functions, as well as associated types and interfaces for TypeScript.

+

The aql function and namespace is also re-exported by the "index" module.

+

Index

Interfaces

Type Aliases

Functions

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/collection.html b/9.0.0-preview.1/modules/collection.html new file mode 100644 index 000000000..25ff7eea3 --- /dev/null +++ b/9.0.0-preview.1/modules/collection.html @@ -0,0 +1,54 @@ +collection | arangojs - v9.0.0-preview.1
\ No newline at end of file diff --git a/9.0.0-preview.1/modules/connection.html b/9.0.0-preview.1/modules/connection.html new file mode 100644 index 000000000..43458a4c8 --- /dev/null +++ b/9.0.0-preview.1/modules/connection.html @@ -0,0 +1,12 @@ +connection | arangojs - v9.0.0-preview.1

Module connection

import type { Config } from "arangojs/connection.js";
+
+

The "connection" module provides connection and configuration related types +for TypeScript.

+

Index

Type Aliases

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/cursor.html b/9.0.0-preview.1/modules/cursor.html new file mode 100644 index 000000000..fda78a666 --- /dev/null +++ b/9.0.0-preview.1/modules/cursor.html @@ -0,0 +1,8 @@ +cursor | arangojs - v9.0.0-preview.1

Module cursor

import type { ArrayCursor, BatchedArrayCursor } from "arangojs/cursor.js";
+
+

The "cursor" module provides cursor-related interfaces for TypeScript.

+

Index

Classes

Interfaces

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/database.html b/9.0.0-preview.1/modules/database.html new file mode 100644 index 000000000..233daeb3e --- /dev/null +++ b/9.0.0-preview.1/modules/database.html @@ -0,0 +1,70 @@ +database | arangojs - v9.0.0-preview.1

Module database

import { Database } from "arangojs/database.js";
+
+

The "database" module provides the Database class and associated +types and interfaces for TypeScript.

+

The Database class is also re-exported by the "index" module.

+

Index

Enumerations

Classes

Type Aliases

Functions

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/documents.html b/9.0.0-preview.1/modules/documents.html new file mode 100644 index 000000000..a04dc5b9e --- /dev/null +++ b/9.0.0-preview.1/modules/documents.html @@ -0,0 +1,14 @@ +documents | arangojs - v9.0.0-preview.1

Module documents

import type { Document, Edge } from "arangojs/documents.js";
+
+

The "documents" module provides document/edge related types for TypeScript.

+

Index

Type Aliases

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/error.html b/9.0.0-preview.1/modules/error.html new file mode 100644 index 000000000..ddd7d546d --- /dev/null +++ b/9.0.0-preview.1/modules/error.html @@ -0,0 +1,10 @@ +error | arangojs - v9.0.0-preview.1

Module error

import type { ArangoError, HttpError } from "arangojs/error.js";
+
+

The "error" module provides types and interfaces for TypeScript related +to arangojs error handling.

+

Index

Classes

Interfaces

Functions

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/foxx_manifest.html b/9.0.0-preview.1/modules/foxx_manifest.html new file mode 100644 index 000000000..c3160c3ed --- /dev/null +++ b/9.0.0-preview.1/modules/foxx_manifest.html @@ -0,0 +1,10 @@ +foxx-manifest | arangojs - v9.0.0-preview.1

Module foxx-manifest

import type { FoxxManifest } from "arangojs/foxx-manifest.js";
+
+

The "foxx-manifest" module provides the Foxx manifest type for TypeScript.

+

Generated from JSON Schema +using json-schema-to-typescript.

+

Index

Type Aliases

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/graph.html b/9.0.0-preview.1/modules/graph.html new file mode 100644 index 000000000..1f633c199 --- /dev/null +++ b/9.0.0-preview.1/modules/graph.html @@ -0,0 +1,20 @@ +graph | arangojs - v9.0.0-preview.1

Module graph

import type {
Graph,
GraphVertexCollection,
GraphEdgeCollection,
} from "arangojs/graph.js"; +
+

The "graph" module provides graph related types and interfaces +for TypeScript.

+

Index

Classes

Type Aliases

Functions

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/index.html b/9.0.0-preview.1/modules/index.html new file mode 100644 index 000000000..06a05eca9 --- /dev/null +++ b/9.0.0-preview.1/modules/index.html @@ -0,0 +1,12 @@ +index | arangojs - v9.0.0-preview.1

Module index

import arangojs, { aql, Database } from "arangojs";
+
+

The "index" module is the default entry point when importing the arangojs +module or using the web build in the browser.

+

If you are just getting started, you probably want to use the +arangojs function, which is also the default export of this module, +or the database.Database class for which it is a wrapper.

+

References

Functions

References

Re-exports Database
Re-exports aql
Renames and re-exports arangojs
\ No newline at end of file diff --git a/9.0.0-preview.1/modules/indexes.html b/9.0.0-preview.1/modules/indexes.html new file mode 100644 index 000000000..93f3e016a --- /dev/null +++ b/9.0.0-preview.1/modules/indexes.html @@ -0,0 +1,25 @@ +indexes | arangojs - v9.0.0-preview.1

Module indexes

import type {
FulltextIndex,
GeoIndex,
MdiIndex,
PersistentIndex,
PrimaryIndex,
TtlIndex,
} from "arangojs/indexes.js"; +
+

The "indexes" module provides index-related types for TypeScript.

+

Index

Type Aliases

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/job.html b/9.0.0-preview.1/modules/job.html new file mode 100644 index 000000000..6b8c4f692 --- /dev/null +++ b/9.0.0-preview.1/modules/job.html @@ -0,0 +1,2 @@ +job | arangojs - v9.0.0-preview.1

Module job

Index

Classes

Job +
\ No newline at end of file diff --git a/9.0.0-preview.1/modules/route.html b/9.0.0-preview.1/modules/route.html new file mode 100644 index 000000000..0ba527a87 --- /dev/null +++ b/9.0.0-preview.1/modules/route.html @@ -0,0 +1,5 @@ +route | arangojs - v9.0.0-preview.1

Module route

import type { Route } from "arangojs/route.js";
+
+

The "route" module provides route related types and interfaces for TypeScript.

+

Index

Classes

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/transaction.html b/9.0.0-preview.1/modules/transaction.html new file mode 100644 index 000000000..30dd84852 --- /dev/null +++ b/9.0.0-preview.1/modules/transaction.html @@ -0,0 +1,10 @@ +transaction | arangojs - v9.0.0-preview.1

Module transaction

import type { Transaction } from "arangojs/transaction.js";
+
+

The "transaction" module provides transaction related types and interfaces +for TypeScript.

+

Index

Classes

Type Aliases

Functions

\ No newline at end of file diff --git a/9.0.0-preview.1/modules/view.html b/9.0.0-preview.1/modules/view.html new file mode 100644 index 000000000..6e973c6f3 --- /dev/null +++ b/9.0.0-preview.1/modules/view.html @@ -0,0 +1,31 @@ +view | arangojs - v9.0.0-preview.1
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.AnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.AnalyzerDescription.html new file mode 100644 index 000000000..814b46d1d --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.AnalyzerDescription.html @@ -0,0 +1,2 @@ +AnalyzerDescription | arangojs - v9.0.0-preview.1
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.AnalyzerFeature.html b/9.0.0-preview.1/types/analyzer.AnalyzerFeature.html new file mode 100644 index 000000000..ab82dc7dd --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.AnalyzerFeature.html @@ -0,0 +1,2 @@ +AnalyzerFeature | arangojs - v9.0.0-preview.1

Type alias AnalyzerFeature

AnalyzerFeature: "frequency" | "norm" | "position" | "offset"

Name of a feature enabled for an Analyzer.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.AqlAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.AqlAnalyzerDescription.html new file mode 100644 index 000000000..ff8374b59 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.AqlAnalyzerDescription.html @@ -0,0 +1,2 @@ +AqlAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias AqlAnalyzerDescription

AqlAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        batchSize: number;
        collapsePositions: boolean;
        keepNull: boolean;
        memoryLimit: number;
        queryString: string;
        returnType: "string" | "number" | "bool";
    };
    type: "aql";
}

An object describing an AQL Analyzer

+

Type declaration

  • properties: {
        batchSize: number;
        collapsePositions: boolean;
        keepNull: boolean;
        memoryLimit: number;
        queryString: string;
        returnType: "string" | "number" | "bool";
    }
    • batchSize: number
    • collapsePositions: boolean
    • keepNull: boolean
    • memoryLimit: number
    • queryString: string
    • returnType: "string" | "number" | "bool"
  • type: "aql"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.ClassificationAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.ClassificationAnalyzerDescription.html new file mode 100644 index 000000000..77e648bfb --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.ClassificationAnalyzerDescription.html @@ -0,0 +1,2 @@ +ClassificationAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias ClassificationAnalyzerDescription

ClassificationAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        model_location: string;
        threshold: number;
        top_k: number;
    };
    type: "classification";
}

(Enterprise Edition only.) An object describing a Classification Analyzer

+

Type declaration

  • properties: {
        model_location: string;
        threshold: number;
        top_k: number;
    }
    • model_location: string
    • threshold: number
    • top_k: number
  • type: "classification"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CollationAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.CollationAnalyzerDescription.html new file mode 100644 index 000000000..d34a62bae --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CollationAnalyzerDescription.html @@ -0,0 +1,2 @@ +CollationAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias CollationAnalyzerDescription

CollationAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        locale: string;
    };
    type: "collation";
}

An object describing a Collation Analyzer

+

Type declaration

  • properties: {
        locale: string;
    }
    • locale: string
  • type: "collation"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateAnalyzerOptions.html new file mode 100644 index 000000000..bf63d358c --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateAnalyzerOptions.html @@ -0,0 +1,2 @@ +CreateAnalyzerOptions | arangojs - v9.0.0-preview.1
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateAqlAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateAqlAnalyzerOptions.html new file mode 100644 index 000000000..cde021d36 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateAqlAnalyzerOptions.html @@ -0,0 +1,17 @@ +CreateAqlAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateAqlAnalyzerOptions

CreateAqlAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        batchSize?: number;
        collapsePositions?: boolean;
        keepNull?: boolean;
        memoryLimit?: number;
        queryString: string;
        returnType?: "string" | "number" | "bool";
    };
    type: "aql";
}

Options for creating an AQL Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        batchSize?: number;
        collapsePositions?: boolean;
        keepNull?: boolean;
        memoryLimit?: number;
        queryString: string;
        returnType?: "string" | "number" | "bool";
    }

    Additional properties for the Analyzer.

    +
    • Optional batchSize?: number

      Number between 1 and 1000 that determines the batch size for reading +data from the query.

      +

      Default: 1

      +
    • Optional collapsePositions?: boolean

      If set to true, the position is set to 0 for all members of the query result array.

      +

      Default: false

      +
    • Optional keepNull?: boolean

      If set to false, null values will be discarded from the View index.

      +

      Default: true

      +
    • Optional memoryLimit?: number

      Memory limit for query execution in bytes.

      +

      Default: 1048576 (1 MiB)

      +
    • queryString: string

      AQL query to be executed.

      +
    • Optional returnType?: "string" | "number" | "bool"

      Data type of the returned tokens.

      +

      Default: "string"

      +
  • type: "aql"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateClassificationAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateClassificationAnalyzerOptions.html new file mode 100644 index 000000000..cf6f48951 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateClassificationAnalyzerOptions.html @@ -0,0 +1,10 @@ +CreateClassificationAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateClassificationAnalyzerOptions

CreateClassificationAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        threshold?: number;
        top_k?: number;
    };
    type: "classification";
}

(Enterprise Edition only.) Options for creating a Classification Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        model_location: string;
        threshold?: number;
        top_k?: number;
    }

    Additional properties for the Analyzer.

    +
    • model_location: string

      On-disk path to the trained fastText supervised model.

      +
    • Optional threshold?: number

      Probability threshold for which a label will be assigned to an input.

      +

      Default: 0.99

      +
    • Optional top_k?: number

      Number of class labels that will be produced per input.

      +

      Default: 1

      +
  • type: "classification"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateCollationAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateCollationAnalyzerOptions.html new file mode 100644 index 000000000..b0ef974a9 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateCollationAnalyzerOptions.html @@ -0,0 +1,7 @@ +CreateCollationAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateCollationAnalyzerOptions

CreateCollationAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "collation";
}

Options for creating a Collation Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        locale: string;
    }

    Additional properties for the Analyzer.

    +
    • locale: string

      Text locale.

      +

      Format: language[_COUNTRY][.encoding][@variant]

      +
  • type: "collation"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateDelimiterAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateDelimiterAnalyzerOptions.html new file mode 100644 index 000000000..cbf17614f --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateDelimiterAnalyzerOptions.html @@ -0,0 +1,7 @@ +CreateDelimiterAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateDelimiterAnalyzerOptions

CreateDelimiterAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: string | {
        delimiter: string;
    };
    type: "delimiter";
}

Options for creating a Delimiter Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: string | {
        delimiter: string;
    }

    Additional properties for the Analyzer.

    +

    The value will be used as delimiter to split text into tokens as specified +in RFC 4180, without starting new records on newlines.

    +
  • type: "delimiter"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateGeoJsonAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateGeoJsonAnalyzerOptions.html new file mode 100644 index 000000000..9e06af817 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateGeoJsonAnalyzerOptions.html @@ -0,0 +1,12 @@ +CreateGeoJsonAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateGeoJsonAnalyzerOptions

CreateGeoJsonAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geojson";
}

Options for creating a GeoJSON Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    }

    Additional properties for the Analyzer.

    +
    • Optional options?: {
          maxCells?: number;
          maxLevel?: number;
          minLevel?: number;
      }

      Options for fine-tuning geo queries.

      +

      Default: { maxCells: 20, minLevel: 4, maxLevel: 23 }

      +
      • Optional maxCells?: number
      • Optional maxLevel?: number
      • Optional minLevel?: number
    • Optional type?: "shape" | "centroid" | "point"

      If set to "centroid", only the centroid of the input geometry will be +computed and indexed.

      +

      If set to "point" only GeoJSON objects of type Point will be indexed and +all other geometry types will be ignored.

      +

      Default: "shape"

      +
  • type: "geojson"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateGeoPointAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateGeoPointAnalyzerOptions.html new file mode 100644 index 000000000..190905602 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateGeoPointAnalyzerOptions.html @@ -0,0 +1,11 @@ +CreateGeoPointAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateGeoPointAnalyzerOptions

CreateGeoPointAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        latitude?: string[];
        longitude?: string[];
        options?: {
            maxLevel?: number;
            minCells?: number;
            minLevel?: number;
        };
    };
    type: "geopoint";
}

Options for creating a GeoPoint Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        latitude?: string[];
        longitude?: string[];
        options?: {
            maxLevel?: number;
            minCells?: number;
            minLevel?: number;
        };
    }

    Additional properties for the Analyzer.

    +
    • Optional latitude?: string[]

      Attribute paths of the latitude value relative to the field for which the +Analyzer is defined in the View.

      +
    • Optional longitude?: string[]

      Attribute paths of the longitude value relative to the field for which the +Analyzer is defined in the View.

      +
    • Optional options?: {
          maxLevel?: number;
          minCells?: number;
          minLevel?: number;
      }

      Options for fine-tuning geo queries.

      +

      Default: { maxCells: 20, minLevel: 4, maxLevel: 23 }

      +
      • Optional maxLevel?: number
      • Optional minCells?: number
      • Optional minLevel?: number
  • type: "geopoint"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateGeoS2AnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateGeoS2AnalyzerOptions.html new file mode 100644 index 000000000..a5ada8e51 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateGeoS2AnalyzerOptions.html @@ -0,0 +1,19 @@ +CreateGeoS2AnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateGeoS2AnalyzerOptions

CreateGeoS2AnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}

(Enterprise Edition only.) Options for creating a Geo S2 Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    }

    Additional properties for the Analyzer.

    +
    • Optional format?: "latLngDouble" | "latLngInt" | "s2Point"

      If set to "latLngDouble", each latitude and longitude value is stored +as an 8-byte floating-point value (16 bytes per coordinate pair).

      +

      If set to "latLngInt", each latitude and longitude value is stored as +a 4-byte integer value (8 bytes per coordinate pair).

      +

      If set to "s2Point", each longitude-latitude pair is stored in the +native format of Google S2 (24 bytes per coordinate pair).

      +

      Default: "latLngDouble"

      +
    • Optional options?: {
          maxCells?: number;
          maxLevel?: number;
          minLevel?: number;
      }

      Options for fine-tuning geo queries.

      +

      Default: { maxCells: 20, minLevel: 4, maxLevel: 23 }

      +
      • Optional maxCells?: number
      • Optional maxLevel?: number
      • Optional minLevel?: number
    • Optional type?: "shape" | "centroid" | "point"

      If set to "centroid", only the centroid of the input geometry will be +computed and indexed.

      +

      If set to "point" only GeoJSON objects of type Point will be indexed and +all other geometry types will be ignored.

      +

      Default: "shape"

      +
  • type: "geo_s2"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateIdentityAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateIdentityAnalyzerOptions.html new file mode 100644 index 000000000..88858af12 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateIdentityAnalyzerOptions.html @@ -0,0 +1,6 @@ +CreateIdentityAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateIdentityAnalyzerOptions

CreateIdentityAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties?: Record<string, never>;
    type: "identity";
}

Options for creating an Identity Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • Optional properties?: Record<string, never>

    Additional properties for the Analyzer.

    +

    The identity Analyzer does not take additional properties.

    +
  • type: "identity"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateMinHashAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateMinHashAnalyzerOptions.html new file mode 100644 index 000000000..7dbaab6ce --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateMinHashAnalyzerOptions.html @@ -0,0 +1,7 @@ +CreateMinHashAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateMinHashAnalyzerOptions

CreateMinHashAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        analyzer: Omit<CreateAnalyzerOptions, "features">;
        numHashes: number;
    };
    type: "minhash";
}

(Enterprise Edition only.) Options for creating a MinHash Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        analyzer: Omit<CreateAnalyzerOptions, "features">;
        numHashes: number;
    }

    Additional properties for the Analyzer.

    +
    • analyzer: Omit<CreateAnalyzerOptions, "features">

      An Analyzer definition-like object with type and properties attributes.

      +
    • numHashes: number

      Size of the MinHash signature.

      +
  • type: "minhash"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateMultiDelimiterAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateMultiDelimiterAnalyzerOptions.html new file mode 100644 index 000000000..23485fd37 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateMultiDelimiterAnalyzerOptions.html @@ -0,0 +1,7 @@ +CreateMultiDelimiterAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateMultiDelimiterAnalyzerOptions

CreateMultiDelimiterAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}

Options for creating a Multi-Delimiter Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        delimiters: string[];
    }

    Additional properties for the Analyzer.

    +

    The value will be used as delimiter to split text into tokens as specified +in RFC 4180, without starting new records on newlines.

    +
    • delimiters: string[]
  • type: "multi_delimiter"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html new file mode 100644 index 000000000..6439c48f3 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html @@ -0,0 +1,8 @@ +CreateNearestNeighborsAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateNearestNeighborsAnalyzerOptions

CreateNearestNeighborsAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        top_k?: number;
    };
    type: "nearest_neighbors";
}

(Enterprise Edition only.) Options for creating a NearestNeighbors Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        model_location: string;
        top_k?: number;
    }

    Additional properties for the Analyzer.

    +
    • model_location: string

      On-disk path to the trained fastText supervised model.

      +
    • Optional top_k?: number

      Number of class labels that will be produced per input.

      +

      Default: 1

      +
  • type: "nearest_neighbors"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateNgramAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateNgramAnalyzerOptions.html new file mode 100644 index 000000000..2487cc099 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateNgramAnalyzerOptions.html @@ -0,0 +1,8 @@ +CreateNgramAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateNgramAnalyzerOptions

CreateNgramAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}

Options for creating an Ngram Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    }

    Additional properties for the Analyzer.

    +
    • max: number

      Maximum n-gram length.

      +
    • min: number

      Minimum n-gram length.

      +
    • preserveOriginal: boolean

      Output the original value as well.

      +
  • type: "ngram"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateNormAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateNormAnalyzerOptions.html new file mode 100644 index 000000000..83b5a54dc --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateNormAnalyzerOptions.html @@ -0,0 +1,11 @@ +CreateNormAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateNormAnalyzerOptions

CreateNormAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}

Options for creating a Norm Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        locale: string;
    }

    Additional properties for the Analyzer.

    +
    • Optional accent?: boolean

      Preserve accents in returned words.

      +

      Default: false

      +
    • Optional case?: "lower" | "none" | "upper"

      Case conversion.

      +

      Default: "lower"

      +
    • locale: string

      Text locale.

      +

      Format: language[_COUNTRY][.encoding][@variant]

      +
  • type: "norm"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreatePipelineAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreatePipelineAnalyzerOptions.html new file mode 100644 index 000000000..92b9b781b --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreatePipelineAnalyzerOptions.html @@ -0,0 +1,6 @@ +CreatePipelineAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreatePipelineAnalyzerOptions

CreatePipelineAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        pipeline: Omit<CreateAnalyzerOptions, "features">[];
    };
    type: "pipeline";
}

Options for creating a Pipeline Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        pipeline: Omit<CreateAnalyzerOptions, "features">[];
    }

    Additional properties for the Analyzer.

    +
    • pipeline: Omit<CreateAnalyzerOptions, "features">[]

      Definitions for Analyzers to chain in this Pipeline Analyzer.

      +
  • type: "pipeline"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateSegmentationAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateSegmentationAnalyzerOptions.html new file mode 100644 index 000000000..32a390059 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateSegmentationAnalyzerOptions.html @@ -0,0 +1,9 @@ +CreateSegmentationAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateSegmentationAnalyzerOptions

CreateSegmentationAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        break?: "all" | "alpha" | "graphic";
        case?: "lower" | "upper" | "none";
    };
    type: "segmentation";
}

Options for creating a Segmentation Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        break?: "all" | "alpha" | "graphic";
        case?: "lower" | "upper" | "none";
    }

    Additional properties for the Analyzer.

    +
    • Optional break?: "all" | "alpha" | "graphic"

      Which tokens should be returned.

      +

      Default: "alpha"

      +
    • Optional case?: "lower" | "upper" | "none"

      What case all returned tokens should be converted to if applicable.

      +

      Default: "none"

      +
  • type: "segmentation"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateStemAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateStemAnalyzerOptions.html new file mode 100644 index 000000000..a88d4c34a --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateStemAnalyzerOptions.html @@ -0,0 +1,7 @@ +CreateStemAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateStemAnalyzerOptions

CreateStemAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "stem";
}

Options for creating a Stem Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        locale: string;
    }

    Additional properties for the Analyzer.

    +

    The value defines the text locale.

    +

    Format: language[_COUNTRY][.encoding][@variant]

    +
    • locale: string
  • type: "stem"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateStopwordsAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateStopwordsAnalyzerOptions.html new file mode 100644 index 000000000..a4b9aaaa5 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateStopwordsAnalyzerOptions.html @@ -0,0 +1,8 @@ +CreateStopwordsAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateStopwordsAnalyzerOptions

CreateStopwordsAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        hex?: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}

Options for creating a Stopwords Analyzer

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        hex?: boolean;
        stopwords: string[];
    }

    Additional properties for the Analyzer.

    +
    • Optional hex?: boolean

      Whether stopword values should be interpreted as hex-encoded strings.

      +

      Default: false

      +
    • stopwords: string[]

      Array of strings that describe the tokens to be discarded.

      +
  • type: "stopwords"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateTextAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateTextAnalyzerOptions.html new file mode 100644 index 000000000..0c16c4408 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateTextAnalyzerOptions.html @@ -0,0 +1,20 @@ +CreateTextAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateTextAnalyzerOptions

CreateTextAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        edgeNgram?: {
            max?: number;
            min?: number;
            preserveOriginal?: boolean;
        };
        locale: string;
        stemming?: boolean;
        stopwords?: string[];
        stopwordsPath?: string;
    };
    type: "text";
}

Options for creating a Text Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        edgeNgram?: {
            max?: number;
            min?: number;
            preserveOriginal?: boolean;
        };
        locale: string;
        stemming?: boolean;
        stopwords?: string[];
        stopwordsPath?: string;
    }

    Additional properties for the Analyzer.

    +
    • Optional accent?: boolean

      Preserve accents in returned words.

      +

      Default: false

      +
    • Optional case?: "lower" | "none" | "upper"

      Case conversion.

      +

      Default: "lower"

      +
    • Optional edgeNgram?: {
          max?: number;
          min?: number;
          preserveOriginal?: boolean;
      }

      If present, then edge n-grams are generated for each token (word).

      +
      • Optional max?: number
      • Optional min?: number
      • Optional preserveOriginal?: boolean
    • locale: string

      Text locale.

      +

      Format: language[_COUNTRY][.encoding][@variant]

      +
    • Optional stemming?: boolean

      Apply stemming on returned words.

      +

      Default: true

      +
    • Optional stopwords?: string[]

      Words to omit from result.

      +

      Defaults to the words loaded from the file at stopwordsPath.

      +
    • Optional stopwordsPath?: string

      Path with a language sub-directory containing files with words to omit.

      +

      Defaults to the path specified in the server-side environment variable +IRESEARCH_TEXT_STOPWORD_PATH or the current working directory of the +ArangoDB process.

      +
  • type: "text"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.CreateWildcardAnalyzerOptions.html b/9.0.0-preview.1/types/analyzer.CreateWildcardAnalyzerOptions.html new file mode 100644 index 000000000..ccc02bd20 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.CreateWildcardAnalyzerOptions.html @@ -0,0 +1,7 @@ +CreateWildcardAnalyzerOptions | arangojs - v9.0.0-preview.1

Type alias CreateWildcardAnalyzerOptions

CreateWildcardAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        analyzer?: Omit<CreateAnalyzerOptions, "features">;
        ngramSize: string;
    };
    type: "wildcard";
}

Options for creating a Wildcard Analyzer.

+

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

    +
  • properties: {
        analyzer?: Omit<CreateAnalyzerOptions, "features">;
        ngramSize: string;
    }

    Additional properties for the Analyzer.

    +
    • Optional analyzer?: Omit<CreateAnalyzerOptions, "features">

      An Analyzer definition-like object with type and properties attributes.

      +
    • ngramSize: string

      N-gram length. Must be a positive integer greater than or equal to 2.

      +
  • type: "wildcard"

    Type of the Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.DelimiterAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.DelimiterAnalyzerDescription.html new file mode 100644 index 000000000..b0893aae8 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.DelimiterAnalyzerDescription.html @@ -0,0 +1,2 @@ +DelimiterAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias DelimiterAnalyzerDescription

DelimiterAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        delimiter: string;
    };
    type: "delimiter";
}

An object describing a Delimiter Analyzer.

+

Type declaration

  • properties: {
        delimiter: string;
    }
    • delimiter: string
  • type: "delimiter"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.GenericAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.GenericAnalyzerDescription.html new file mode 100644 index 000000000..2de05cfde --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.GenericAnalyzerDescription.html @@ -0,0 +1,4 @@ +GenericAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias GenericAnalyzerDescription

GenericAnalyzerDescription: {
    features: AnalyzerFeature[];
    name: string;
}

Shared attributes of all Analyzer descriptions.

+

Type declaration

  • features: AnalyzerFeature[]

    Features enabled for this Analyzer.

    +
  • name: string

    A unique name for this Analyzer.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.GeoJsonAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.GeoJsonAnalyzerDescription.html new file mode 100644 index 000000000..e8443cbe5 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.GeoJsonAnalyzerDescription.html @@ -0,0 +1,2 @@ +GeoJsonAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias GeoJsonAnalyzerDescription

GeoJsonAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        type: "shape" | "centroid" | "point";
    };
    type: "geojson";
}

An object describing a GeoJSON Analyzer

+

Type declaration

  • properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        type: "shape" | "centroid" | "point";
    }
    • description: {
          maxCells: number;
          maxLevel: number;
          minLevel: number;
      }
      • maxCells: number
      • maxLevel: number
      • minLevel: number
    • type: "shape" | "centroid" | "point"
  • type: "geojson"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.GeoPointAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.GeoPointAnalyzerDescription.html new file mode 100644 index 000000000..9e4806503 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.GeoPointAnalyzerDescription.html @@ -0,0 +1,2 @@ +GeoPointAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias GeoPointAnalyzerDescription

GeoPointAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        description: {
            maxLevel: number;
            minCells: number;
            minLevel: number;
        };
        latitude: string[];
        longitude: string[];
    };
    type: "geopoint";
}

An object describing a GeoPoint Analyzer

+

Type declaration

  • properties: {
        description: {
            maxLevel: number;
            minCells: number;
            minLevel: number;
        };
        latitude: string[];
        longitude: string[];
    }
    • description: {
          maxLevel: number;
          minCells: number;
          minLevel: number;
      }
      • maxLevel: number
      • minCells: number
      • minLevel: number
    • latitude: string[]
    • longitude: string[]
  • type: "geopoint"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.GeoS2AnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.GeoS2AnalyzerDescription.html new file mode 100644 index 000000000..94a717734 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.GeoS2AnalyzerDescription.html @@ -0,0 +1,2 @@ +GeoS2AnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias GeoS2AnalyzerDescription

GeoS2AnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        format: "latLngDouble" | "latLngInt" | "s2Point";
        type: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}

(Enterprise Edition only.) An object describing a GeoS2 Analyzer

+

Type declaration

  • properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        format: "latLngDouble" | "latLngInt" | "s2Point";
        type: "shape" | "centroid" | "point";
    }
    • description: {
          maxCells: number;
          maxLevel: number;
          minLevel: number;
      }
      • maxCells: number
      • maxLevel: number
      • minLevel: number
    • format: "latLngDouble" | "latLngInt" | "s2Point"
    • type: "shape" | "centroid" | "point"
  • type: "geo_s2"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.IdentityAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.IdentityAnalyzerDescription.html new file mode 100644 index 000000000..dd4c53431 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.IdentityAnalyzerDescription.html @@ -0,0 +1,2 @@ +IdentityAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias IdentityAnalyzerDescription

IdentityAnalyzerDescription: GenericAnalyzerDescription & {
    properties: Record<string, never>;
    type: "identity";
}

An object describing an Identity Analyzer.

+

Type declaration

  • properties: Record<string, never>
  • type: "identity"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.MinHashAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.MinHashAnalyzerDescription.html new file mode 100644 index 000000000..37027952f --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.MinHashAnalyzerDescription.html @@ -0,0 +1,2 @@ +MinHashAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias MinHashAnalyzerDescription

MinHashAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        analyzer: Omit<AnalyzerDescription, "name" | "features">;
        numHashes: number;
    };
    type: "minhash";
}

(Enterprise Edition only.) An object describing a MinHash Analyzer

+

Type declaration

  • properties: {
        analyzer: Omit<AnalyzerDescription, "name" | "features">;
        numHashes: number;
    }
  • type: "minhash"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.MultiDelimiterAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.MultiDelimiterAnalyzerDescription.html new file mode 100644 index 000000000..d1bb7b69c --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.MultiDelimiterAnalyzerDescription.html @@ -0,0 +1,2 @@ +MultiDelimiterAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias MultiDelimiterAnalyzerDescription

MultiDelimiterAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}

An object describing a Multi Delimiter Analyzer.

+

Type declaration

  • properties: {
        delimiters: string[];
    }
    • delimiters: string[]
  • type: "multi_delimiter"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.NearestNeighborsAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.NearestNeighborsAnalyzerDescription.html new file mode 100644 index 000000000..43180468e --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.NearestNeighborsAnalyzerDescription.html @@ -0,0 +1,2 @@ +NearestNeighborsAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias NearestNeighborsAnalyzerDescription

NearestNeighborsAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        model_location: string;
        top_k: number;
    };
    type: "nearest_neighbors";
}

(Enterprise Edition only.) An object describing a NearestNeighbors Analyzer

+

Type declaration

  • properties: {
        model_location: string;
        top_k: number;
    }
    • model_location: string
    • top_k: number
  • type: "nearest_neighbors"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.NgramAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.NgramAnalyzerDescription.html new file mode 100644 index 000000000..0ede0291e --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.NgramAnalyzerDescription.html @@ -0,0 +1,2 @@ +NgramAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias NgramAnalyzerDescription

NgramAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}

An object describing an Ngram Analyzer.

+

Type declaration

  • properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    }
    • max: number
    • min: number
    • preserveOriginal: boolean
  • type: "ngram"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.NormAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.NormAnalyzerDescription.html new file mode 100644 index 000000000..e21e9169b --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.NormAnalyzerDescription.html @@ -0,0 +1,2 @@ +NormAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias NormAnalyzerDescription

NormAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}

An object describing a Norm Analyzer.

+

Type declaration

  • properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        locale: string;
    }
    • accent: boolean
    • case: "lower" | "none" | "upper"
    • locale: string
  • type: "norm"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.PipelineAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.PipelineAnalyzerDescription.html new file mode 100644 index 000000000..772124afa --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.PipelineAnalyzerDescription.html @@ -0,0 +1,2 @@ +PipelineAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias PipelineAnalyzerDescription

PipelineAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        pipeline: Omit<AnalyzerDescription, "name" | "features">[];
    };
    type: "pipeline";
}

An object describing a Pipeline Analyzer

+

Type declaration

\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.SegmentationAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.SegmentationAnalyzerDescription.html new file mode 100644 index 000000000..ed98aa03f --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.SegmentationAnalyzerDescription.html @@ -0,0 +1,2 @@ +SegmentationAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias SegmentationAnalyzerDescription

SegmentationAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        break: "all" | "alpha" | "graphic";
        case: "lower" | "upper" | "none";
    };
    type: "segmentation";
}

An object describing a Segmentation Analyzer

+

Type declaration

  • properties: {
        break: "all" | "alpha" | "graphic";
        case: "lower" | "upper" | "none";
    }
    • break: "all" | "alpha" | "graphic"
    • case: "lower" | "upper" | "none"
  • type: "segmentation"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.StemAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.StemAnalyzerDescription.html new file mode 100644 index 000000000..a5f194e49 --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.StemAnalyzerDescription.html @@ -0,0 +1,2 @@ +StemAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias StemAnalyzerDescription

StemAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        locale: string;
    };
    type: "stem";
}

An object describing a Stem Analyzer.

+

Type declaration

  • properties: {
        locale: string;
    }
    • locale: string
  • type: "stem"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.StopwordsAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.StopwordsAnalyzerDescription.html new file mode 100644 index 000000000..3ecab46de --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.StopwordsAnalyzerDescription.html @@ -0,0 +1,2 @@ +StopwordsAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias StopwordsAnalyzerDescription

StopwordsAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        hex: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}

An object describing a Stopwords Analyzer

+

Type declaration

  • properties: {
        hex: boolean;
        stopwords: string[];
    }
    • hex: boolean
    • stopwords: string[]
  • type: "stopwords"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.TextAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.TextAnalyzerDescription.html new file mode 100644 index 000000000..5ed08291b --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.TextAnalyzerDescription.html @@ -0,0 +1,2 @@ +TextAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias TextAnalyzerDescription

TextAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        edgeNgram: {
            max: number;
            min: number;
            preserveOriginal: boolean;
        };
        locale: string;
        stemming: boolean;
        stopwords: string[];
        stopwordsPath: string;
    };
    type: "text";
}

An object describing a Text Analyzer.

+

Type declaration

  • properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        edgeNgram: {
            max: number;
            min: number;
            preserveOriginal: boolean;
        };
        locale: string;
        stemming: boolean;
        stopwords: string[];
        stopwordsPath: string;
    }
    • accent: boolean
    • case: "lower" | "none" | "upper"
    • edgeNgram: {
          max: number;
          min: number;
          preserveOriginal: boolean;
      }
      • max: number
      • min: number
      • preserveOriginal: boolean
    • locale: string
    • stemming: boolean
    • stopwords: string[]
    • stopwordsPath: string
  • type: "text"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/analyzer.WildcardAnalyzerDescription.html b/9.0.0-preview.1/types/analyzer.WildcardAnalyzerDescription.html new file mode 100644 index 000000000..42c5d006d --- /dev/null +++ b/9.0.0-preview.1/types/analyzer.WildcardAnalyzerDescription.html @@ -0,0 +1,2 @@ +WildcardAnalyzerDescription | arangojs - v9.0.0-preview.1

Type alias WildcardAnalyzerDescription

WildcardAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        analyzer?: Omit<AnalyzerDescription, "name" | "features">;
        ngramSize: number;
    };
    type: "wildcard";
}

An object describing a Wildcard Analyzer

+

Type declaration

  • properties: {
        analyzer?: Omit<AnalyzerDescription, "name" | "features">;
        ngramSize: number;
    }
  • type: "wildcard"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/aql.AqlValue.html b/9.0.0-preview.1/types/aql.AqlValue.html new file mode 100644 index 000000000..13d78711e --- /dev/null +++ b/9.0.0-preview.1/types/aql.AqlValue.html @@ -0,0 +1,3 @@ +AqlValue | arangojs - v9.0.0-preview.1

Type alias AqlValue

AqlValue: ArangoCollection | View | Graph | GeneratedAqlQuery | AqlLiteral | string | number | boolean | null | undefined | Record<string, any> | any[]

A value that can be used in an AQL template string or passed to an AQL +helper function.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionBatchReadOptions.html b/9.0.0-preview.1/types/collection.CollectionBatchReadOptions.html new file mode 100644 index 000000000..473f101f1 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionBatchReadOptions.html @@ -0,0 +1,5 @@ +CollectionBatchReadOptions | arangojs - v9.0.0-preview.1

Type alias CollectionBatchReadOptions

CollectionBatchReadOptions: {
    allowDirtyRead?: boolean;
}

Options for retrieving multiple documents from a collection.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionChecksumOptions.html b/9.0.0-preview.1/types/collection.CollectionChecksumOptions.html new file mode 100644 index 000000000..3a5ee7dd4 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionChecksumOptions.html @@ -0,0 +1,8 @@ +CollectionChecksumOptions | arangojs - v9.0.0-preview.1

Type alias CollectionChecksumOptions

CollectionChecksumOptions: {
    withData?: boolean;
    withRevisions?: boolean;
}

Options for retrieving a collection checksum.

+

Type declaration

  • Optional withData?: boolean

    If set to true, document data will be included in the calculation +of the checksum.

    +

    Default: false

    +
  • Optional withRevisions?: boolean

    If set to true, revision IDs will be included in the calculation +of the checksum.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionDropOptions.html b/9.0.0-preview.1/types/collection.CollectionDropOptions.html new file mode 100644 index 000000000..595c302bf --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionDropOptions.html @@ -0,0 +1,6 @@ +CollectionDropOptions | arangojs - v9.0.0-preview.1

Type alias CollectionDropOptions

CollectionDropOptions: {
    isSystem?: boolean;
}

Options for dropping collections.

+

Type declaration

  • Optional isSystem?: boolean

    Whether the collection is a system collection. If the collection is a +system collection, this option must be set to true or ArangoDB will +refuse to drop the collection.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionEdgesOptions.html b/9.0.0-preview.1/types/collection.CollectionEdgesOptions.html new file mode 100644 index 000000000..a7e6d472a --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionEdgesOptions.html @@ -0,0 +1,5 @@ +CollectionEdgesOptions | arangojs - v9.0.0-preview.1

Type alias CollectionEdgesOptions

CollectionEdgesOptions: {
    allowDirtyRead?: boolean;
}

Options for retrieving a document's edges from a collection.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionEdgesResult.html b/9.0.0-preview.1/types/collection.CollectionEdgesResult.html new file mode 100644 index 000000000..47f88dfb8 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionEdgesResult.html @@ -0,0 +1,2 @@ +CollectionEdgesResult | arangojs - v9.0.0-preview.1

Type alias CollectionEdgesResult<T>

CollectionEdgesResult<T>: {
    edges: Edge<T>[];
    stats: {
        filtered: number;
        scannedIndex: number;
    };
}

Result of retrieving edges in a collection.

+

Type Parameters

  • T extends Record<string, any> = any

Type declaration

  • edges: Edge<T>[]
  • stats: {
        filtered: number;
        scannedIndex: number;
    }
    • filtered: number
    • scannedIndex: number
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionImportOptions.html b/9.0.0-preview.1/types/collection.CollectionImportOptions.html new file mode 100644 index 000000000..2271d2677 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionImportOptions.html @@ -0,0 +1,19 @@ +CollectionImportOptions | arangojs - v9.0.0-preview.1

Type alias CollectionImportOptions

CollectionImportOptions: {
    complete?: boolean;
    details?: boolean;
    fromPrefix?: string;
    onDuplicate?: "error" | "update" | "replace" | "ignore";
    overwrite?: boolean;
    toPrefix?: string;
    waitForSync?: boolean;
}

Options for bulk importing documents into a collection.

+

Type declaration

  • Optional complete?: boolean

    If set to true, the import will abort if any error occurs.

    +
  • Optional details?: boolean

    Whether the response should contain additional details about documents +that could not be imported.

    +
  • Optional fromPrefix?: string

    (Edge collections only.) Prefix to prepend to _from attribute values.

    +
  • Optional onDuplicate?: "error" | "update" | "replace" | "ignore"

    Controls behavior when a unique constraint is violated on the document key.

    +
      +
    • "error": the document will not be imported.
    • +
    • "update: the document will be merged into the existing document.
    • +
    • "replace": the document will replace the existing document.
    • +
    • "ignore": the document will not be imported and the unique constraint +error will be ignored.
    • +
    +

    Default: "error"

    +
  • Optional overwrite?: boolean

    If set to true, the collection is truncated before the data is imported.

    +

    Default: false

    +
  • Optional toPrefix?: string

    (Edge collections only.) Prefix to prepend to _to attribute values.

    +
  • Optional waitForSync?: boolean

    Whether to wait for the documents to have been synced to disk.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionImportResult.html b/9.0.0-preview.1/types/collection.CollectionImportResult.html new file mode 100644 index 000000000..e5e8f8f66 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionImportResult.html @@ -0,0 +1,9 @@ +CollectionImportResult | arangojs - v9.0.0-preview.1

Type alias CollectionImportResult

CollectionImportResult: {
    created: number;
    details?: string[];
    empty: number;
    error: false;
    errors: number;
    ignored: number;
    updated: number;
}

Result of a collection bulk import.

+

Type declaration

  • created: number

    Number of new documents imported.

    +
  • Optional details?: string[]

    Additional details about any errors encountered during the import.

    +
  • empty: number

    Number of empty documents.

    +
  • error: false

    Whether the import failed.

    +
  • errors: number

    Number of documents that failed with an error.

    +
  • ignored: number

    Number of documents that failed with an error that is ignored.

    +
  • updated: number

    Number of documents updated.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionInsertOptions.html b/9.0.0-preview.1/types/collection.CollectionInsertOptions.html new file mode 100644 index 000000000..d2514b80e --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionInsertOptions.html @@ -0,0 +1,30 @@ +CollectionInsertOptions | arangojs - v9.0.0-preview.1

Type alias CollectionInsertOptions

CollectionInsertOptions: {
    mergeObjects?: boolean;
    overwriteMode?: "ignore" | "update" | "replace" | "conflict";
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}

Options for inserting a new document into a collection.

+

Type declaration

  • Optional mergeObjects?: boolean

    If set to false, object properties that already exist in the old +document will be overwritten rather than merged when an existing document +with the same _key or _id is updated. This does not affect arrays.

    +

    Default: true

    +
  • Optional overwriteMode?: "ignore" | "update" | "replace" | "conflict"

    Defines what should happen if a document with the same _key or _id +already exists, instead of throwing an exception.

    +

    Default: `"conflict"

    +
  • Optional refillIndexCaches?: boolean

    If set to true, new entries will be added to in-memory index caches if +document insertions affect the edge index or cache-enabled persistent +indexes.

    +

    Default: false

    +
  • Optional returnNew?: boolean

    If set to true, the complete new document will be returned as the new +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true. +This option is only available when overwriteMode is set to "update" or +"replace".

    +

    Default: false

    +
  • Optional silent?: boolean

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • Optional versionAttribute?: string

    If set, the attribute with the name specified by the option is looked up +in the stored document and the attribute value is compared numerically to +the value of the versioning attribute in the supplied document that is +supposed to update/replace it.

    +
  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionKeyOptions.html b/9.0.0-preview.1/types/collection.CollectionKeyOptions.html new file mode 100644 index 000000000..1ced5aa30 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionKeyOptions.html @@ -0,0 +1,8 @@ +CollectionKeyOptions | arangojs - v9.0.0-preview.1

Type alias CollectionKeyOptions

CollectionKeyOptions: {
    allowUserKeys?: boolean;
    increment?: number;
    offset?: number;
    type?: KeyGenerator;
}

An object defining the collection's key generation.

+

Type declaration

  • Optional allowUserKeys?: boolean

    Unless set to false, documents can be created with a user-specified +_key attribute.

    +

    Default: true

    +
  • Optional increment?: number

    (Autoincrement only.) How many steps to increment the key each time.

    +
  • Optional offset?: number

    (Autoincrement only.) Initial offset for the key.

    +
  • Optional type?: KeyGenerator

    Type of key generator to use.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionKeyProperties.html b/9.0.0-preview.1/types/collection.CollectionKeyProperties.html new file mode 100644 index 000000000..09125bda4 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionKeyProperties.html @@ -0,0 +1,7 @@ +CollectionKeyProperties | arangojs - v9.0.0-preview.1

Type alias CollectionKeyProperties

CollectionKeyProperties: {
    allowUserKeys: boolean;
    increment?: number;
    lastValue: number;
    offset?: number;
    type: KeyGenerator;
}

An object defining the collection's key generation.

+

Type declaration

  • allowUserKeys: boolean

    Whether documents can be created with a user-specified _key attribute.

    +
  • Optional increment?: number

    (Autoincrement only.) How many steps to increment the key each time.

    +
  • lastValue: number

    Most recent key that has been generated.

    +
  • Optional offset?: number

    (Autoincrement only.) Initial offset for the key.

    +
  • type: KeyGenerator

    Type of key generator to use.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionMetadata.html b/9.0.0-preview.1/types/collection.CollectionMetadata.html new file mode 100644 index 000000000..2c34af871 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionMetadata.html @@ -0,0 +1,6 @@ +CollectionMetadata | arangojs - v9.0.0-preview.1

Type alias CollectionMetadata

CollectionMetadata: {
    globallyUniqueId: string;
    name: string;
    status: CollectionStatus;
    type: CollectionType;
}

General information about a collection.

+

Type declaration

  • globallyUniqueId: string

    A globally unique identifier for this collection.

    +
  • name: string

    Collection name.

    +
  • status: CollectionStatus

    An integer indicating the collection loading status.

    +
  • type: CollectionType

    An integer indicating the collection type.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionProperties.html b/9.0.0-preview.1/types/collection.CollectionProperties.html new file mode 100644 index 000000000..225be6cb1 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionProperties.html @@ -0,0 +1,25 @@ +CollectionProperties | arangojs - v9.0.0-preview.1

Type alias CollectionProperties

CollectionProperties: {
    cacheEnabled: boolean;
    computedValues: ComputedValueProperties[];
    distributeShardsLike?: string;
    isDisjoint?: string;
    isSmart?: boolean;
    keyOptions: CollectionKeyProperties;
    numberOfShards?: number;
    replicationFactor?: number | "satellite";
    schema: SchemaProperties | null;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    statusString: string;
    syncByRevision: boolean;
    waitForSync: boolean;
    writeConcern: number;
}

An object defining the properties of a collection.

+

Type declaration

  • cacheEnabled: boolean

    Whether the in-memory hash cache is enabled for this collection.

    +
  • computedValues: ComputedValueProperties[]

    Computed values applied to documents in this collection.

    +
  • Optional distributeShardsLike?: string

    (Enterprise Edition cluster only.) If set to a collection name, sharding +of the new collection will follow the rules for that collection. As long +as the new collection exists, the indicated collection can not be dropped.

    +
  • Optional isDisjoint?: string

    (Enterprise Edition only.) Whether the SmartGraph this collection belongs to is disjoint.

    +
  • Optional isSmart?: boolean

    (Enterprise Edition only.) Whether the collection is used in a SmartGraph or EnterpriseGraph.

    +
  • keyOptions: CollectionKeyProperties

    An object defining the collection's key generation.

    +
  • Optional numberOfShards?: number

    (Cluster only.) Number of shards of this collection.

    +
  • Optional replicationFactor?: number | "satellite"

    (Cluster only.) Replication factor of the collection.

    +
  • schema: SchemaProperties | null

    Properties for validating documents in the collection.

    +
  • Optional shardKeys?: string[]

    (Cluster only.) Keys of this collection that will be used for +sharding.

    +
  • Optional shardingStrategy?: ShardingStrategy

    (Cluster only.) Sharding strategy of the collection.

    +
  • Optional smartGraphAttribute?: string

    (Enterprise Edition cluster only.) Attribute used for sharding.

    +
  • Optional smartJoinAttribute?: string

    (Enterprise Edition cluster only.) Attribute containing the shard key +value of the referred-to smart join collection.

    +
  • statusString: string

    A human-readable representation of the collection loading status.

    +
  • syncByRevision: boolean

    Whether the newer revision-based replication protocol is enabled for +this collection.

    +
  • waitForSync: boolean

    Whether data should be synchronized to disk before returning from +a document create, update, replace or removal operation.

    +
  • writeConcern: number

    (Cluster only.) Write concern for this collection.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionPropertiesOptions.html b/9.0.0-preview.1/types/collection.CollectionPropertiesOptions.html new file mode 100644 index 000000000..2abb87b4a --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionPropertiesOptions.html @@ -0,0 +1,13 @@ +CollectionPropertiesOptions | arangojs - v9.0.0-preview.1

Type alias CollectionPropertiesOptions

CollectionPropertiesOptions: {
    cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    replicationFactor?: number | "satellite";
    schema?: SchemaOptions;
    waitForSync?: boolean;
    writeConcern?: number;
}

Options for setting a collection's properties.

+

See DocumentCollection#properties and EdgeCollection#properties.

+

Type declaration

  • Optional cacheEnabled?: boolean

    Whether the in-memory hash cache is enabled for this collection.

    +

    Default: false

    +
  • Optional computedValues?: ComputedValueOptions[]

    Computed values to apply to documents in this collection.

    +
  • Optional replicationFactor?: number | "satellite"

    (Cluster only.) How many copies of each document should be kept in the +cluster.

    +

    Default: 1

    +
  • Optional schema?: SchemaOptions

    Options for validating documents in this collection.

    +
  • Optional waitForSync?: boolean

    Whether data should be synchronized to disk before returning from +a document create, update, replace or removal operation.

    +
  • Optional writeConcern?: number

    (Cluster only.) Write concern for this collection.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionReadOptions.html b/9.0.0-preview.1/types/collection.CollectionReadOptions.html new file mode 100644 index 000000000..86b8a0cb0 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionReadOptions.html @@ -0,0 +1,12 @@ +CollectionReadOptions | arangojs - v9.0.0-preview.1

Type alias CollectionReadOptions

CollectionReadOptions: {
    allowDirtyRead?: boolean;
    graceful?: boolean;
    ifMatch?: string;
    ifNoneMatch?: string;
}

Options for retrieving a document from a collection.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
  • Optional graceful?: boolean

    If set to true, null is returned instead of an exception being thrown +if the document does not exist.

    +
  • Optional ifMatch?: string

    If set to a document revision, the request will fail with an error if the +document exists but its _rev does not match the given revision.

    +
  • Optional ifNoneMatch?: string

    If set to a document revision, the request will fail with an error if the +document exists and its _rev matches the given revision. Note that an +HttpError with code 304 will be thrown instead of an ArangoError.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionRemoveOptions.html b/9.0.0-preview.1/types/collection.CollectionRemoveOptions.html new file mode 100644 index 000000000..78dfcd60e --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionRemoveOptions.html @@ -0,0 +1,16 @@ +CollectionRemoveOptions | arangojs - v9.0.0-preview.1

Type alias CollectionRemoveOptions

CollectionRemoveOptions: {
    ifMatch?: string;
    refillIndexCaches?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}

Options for removing a document from a collection.

+

Type declaration

  • Optional ifMatch?: string

    If set to a document revision, the document will only be removed if its +_rev matches the given revision.

    +
  • Optional refillIndexCaches?: boolean

    If set to true, existing entries in in-memory index caches will be +deleted if document removals affect the edge index or cache-enabled +persistent indexes.

    +

    Default: false

    +
  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • Optional silent?: boolean

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • Optional waitForSync?: boolean

    If set to true, changes will be synchronized to disk before returning.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionReplaceOptions.html b/9.0.0-preview.1/types/collection.CollectionReplaceOptions.html new file mode 100644 index 000000000..37a95648e --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionReplaceOptions.html @@ -0,0 +1,26 @@ +CollectionReplaceOptions | arangojs - v9.0.0-preview.1

Type alias CollectionReplaceOptions

CollectionReplaceOptions: {
    ifMatch?: string;
    ignoreRevs?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}

Options for replacing an existing document in a collection.

+

Type declaration

  • Optional ifMatch?: string

    If set to a document revision, the document will only be replaced if its +_rev matches the given revision.

    +
  • Optional ignoreRevs?: boolean

    If set to false, the existing document will only be modified if its +_rev property matches the same property on the new data.

    +

    Default: true

    +
  • Optional refillIndexCaches?: boolean

    If set to true, existing entries in in-memory index caches will be +updated if document replacements affect the edge index or cache-enabled +persistent indexes.

    +

    Default: false

    +
  • Optional returnNew?: boolean

    If set to true, the complete new document will be returned as the new +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • Optional silent?: boolean

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • Optional versionAttribute?: string

    If set, the attribute with the name specified by the option is looked up +in the stored document and the attribute value is compared numerically to +the value of the versioning attribute in the supplied document that is +supposed to update/replace it.

    +
  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CollectionUpdateOptions.html b/9.0.0-preview.1/types/collection.CollectionUpdateOptions.html new file mode 100644 index 000000000..b3c3c5808 --- /dev/null +++ b/9.0.0-preview.1/types/collection.CollectionUpdateOptions.html @@ -0,0 +1,33 @@ +CollectionUpdateOptions | arangojs - v9.0.0-preview.1

Type alias CollectionUpdateOptions

CollectionUpdateOptions: {
    ifMatch?: string;
    ignoreRevs?: boolean;
    keepNull?: boolean;
    mergeObjects?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}

Options for updating a document in a collection.

+

Type declaration

  • Optional ifMatch?: string

    If set to a document revision, the document will only be updated if its +_rev matches the given revision.

    +
  • Optional ignoreRevs?: boolean

    If set to false, the existing document will only be modified if its +_rev property matches the same property on the new data.

    +

    Default: true

    +
  • Optional keepNull?: boolean

    If set to false, properties with a value of null will be removed from +the new document.

    +

    Default: true

    +
  • Optional mergeObjects?: boolean

    If set to false, object properties that already exist in the old +document will be overwritten rather than merged. This does not affect +arrays.

    +

    Default: true

    +
  • Optional refillIndexCaches?: boolean

    If set to true, existing entries in in-memory index caches will be +updated if document updates affect the edge index or cache-enabled +persistent indexes.

    +

    Default: false

    +
  • Optional returnNew?: boolean

    If set to true, the complete new document will be returned as the new +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • Optional silent?: boolean

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • Optional versionAttribute?: string

    If set, the attribute with the name specified by the option is looked up +in the stored document and the attribute value is compared numerically to +the value of the versioning attribute in the supplied document that is +supposed to update/replace it.

    +
  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.ComputedValueOptions.html b/9.0.0-preview.1/types/collection.ComputedValueOptions.html new file mode 100644 index 000000000..1fbc9749b --- /dev/null +++ b/9.0.0-preview.1/types/collection.ComputedValueOptions.html @@ -0,0 +1,17 @@ +ComputedValueOptions | arangojs - v9.0.0-preview.1

Type alias ComputedValueOptions

ComputedValueOptions: {
    computeOn?: WriteOperation[];
    expression: string | AqlLiteral | AqlQuery;
    failOnWarning?: boolean;
    keepNull?: boolean;
    name: string;
    overwrite?: boolean;
}

Options for creating a computed value.

+

Type declaration

  • Optional computeOn?: WriteOperation[]

    Which operations should result in the value being computed.

    +

    Default: ["insert", "update", "replace"]

    +
  • expression: string | AqlLiteral | AqlQuery

    AQL RETURN expression that computes the value.

    +

    Note that when passing an AQL query object, the bindVars will be ignored.

    +
  • Optional failOnWarning?: boolean

    Whether the write operation should fail if the expression produces a +warning.

    +

    Default: false

    +
  • Optional keepNull?: boolean

    If set to false, the field will be unset if the expression evaluates to +null. Otherwise the field will be set to the value null. Has no effect +if overwrite is set to false.

    +

    Default: true

    +
  • name: string

    Name of the target attribute of the computed value.

    +
  • Optional overwrite?: boolean

    If set to false, the computed value will not be applied if the +expression evaluates to null.

    +

    Default: true

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.ComputedValueProperties.html b/9.0.0-preview.1/types/collection.ComputedValueProperties.html new file mode 100644 index 000000000..312b267d4 --- /dev/null +++ b/9.0.0-preview.1/types/collection.ComputedValueProperties.html @@ -0,0 +1,12 @@ +ComputedValueProperties | arangojs - v9.0.0-preview.1

Type alias ComputedValueProperties

ComputedValueProperties: {
    computeOn: WriteOperation[];
    expression: string;
    failOnWarning: boolean;
    keepNull: boolean;
    name: string;
    overwrite: boolean;
}

Properties defining a computed value.

+

Type declaration

  • computeOn: WriteOperation[]

    Which operations should result in the value being computed.

    +
  • expression: string

    AQL RETURN expression that computes the value.

    +
  • failOnWarning: boolean

    Whether the write operation should fail if the expression produces a +warning.

    +
  • keepNull: boolean

    If set to false, the field will be unset if the expression evaluates to +null. Otherwise the field will be set to the value null. Has no effect +if overwrite is set to false.

    +
  • name: string

    Name of the target attribute of the computed value.

    +
  • overwrite: boolean

    If set to false, the computed value will not be applied if the +expression evaluates to null.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.CreateCollectionOptions.html b/9.0.0-preview.1/types/collection.CreateCollectionOptions.html new file mode 100644 index 000000000..f4877ca8d --- /dev/null +++ b/9.0.0-preview.1/types/collection.CreateCollectionOptions.html @@ -0,0 +1,33 @@ +CreateCollectionOptions | arangojs - v9.0.0-preview.1

Type alias CreateCollectionOptions

CreateCollectionOptions: {
    cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    distributeShardsLike?: string;
    enforceReplicationFactor?: boolean;
    keyOptions?: CollectionKeyOptions;
    numberOfShards?: number;
    replicationFactor?: number;
    schema?: SchemaOptions;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    waitForSync?: boolean;
    waitForSyncReplication?: boolean;
    writeConcern?: number;
}

Type declaration

  • Optional cacheEnabled?: boolean

    Whether the in-memory hash cache is enabled for this collection.

    +
  • Optional computedValues?: ComputedValueOptions[]

    Computed values to apply to documents in this collection.

    +
  • Optional distributeShardsLike?: string

    (Enterprise Edition cluster only.) If set to a collection name, sharding +of the new collection will follow the rules for that collection. As long +as the new collection exists, the indicated collection can not be dropped.

    +
  • Optional enforceReplicationFactor?: boolean

    (Cluster only.) Unless set to false, the server will check whether +enough replicas are available at creation time and bail out otherwise.

    +

    Default: true

    +
  • Optional keyOptions?: CollectionKeyOptions

    An object defining the collection's key generation.

    +
  • Optional numberOfShards?: number

    (Cluster only.) Number of shards to distribute the collection across.

    +

    Default: 1

    +
  • Optional replicationFactor?: number

    (Cluster only.) How many copies of each document should be kept in the +cluster.

    +

    Default: 1

    +
  • Optional schema?: SchemaOptions

    Options for validating documents in the collection.

    +
  • Optional shardKeys?: string[]

    (Cluster only.) Document attributes to use to determine the target shard +for each document.

    +

    Default: ["_key"]

    +
  • Optional shardingStrategy?: ShardingStrategy

    (Cluster only.) Sharding strategy to use.

    +
  • Optional smartGraphAttribute?: string

    (Enterprise Edition cluster only.) Attribute used for sharding.

    +
  • Optional smartJoinAttribute?: string

    (Enterprise Edition cluster only.) Attribute containing the shard key +value of the referred-to smart join collection.

    +
  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning from +a document create, update, replace or removal operation.

    +

    Default: false

    +
  • Optional waitForSyncReplication?: boolean

    (Cluster only.) Unless set to false, the server will wait for all +replicas to create the collection before returning.

    +

    Default: true

    +
  • Optional writeConcern?: number

    (Cluster only.) Write concern for this collection.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.DocumentExistsOptions.html b/9.0.0-preview.1/types/collection.DocumentExistsOptions.html new file mode 100644 index 000000000..27773e4d6 --- /dev/null +++ b/9.0.0-preview.1/types/collection.DocumentExistsOptions.html @@ -0,0 +1,6 @@ +DocumentExistsOptions | arangojs - v9.0.0-preview.1

Type alias DocumentExistsOptions

DocumentExistsOptions: {
    ifMatch?: string;
    ifNoneMatch?: string;
}

Options for checking whether a document exists in a collection.

+

Type declaration

  • Optional ifMatch?: string

    If set to a document revision, the document will only match if its _rev +matches the given revision.

    +
  • Optional ifNoneMatch?: string

    If set to a document revision, the document will only match if its _rev +does not match the given revision.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.DocumentOperationFailure.html b/9.0.0-preview.1/types/collection.DocumentOperationFailure.html new file mode 100644 index 000000000..1a0d82a7e --- /dev/null +++ b/9.0.0-preview.1/types/collection.DocumentOperationFailure.html @@ -0,0 +1,5 @@ +DocumentOperationFailure | arangojs - v9.0.0-preview.1

Type alias DocumentOperationFailure

DocumentOperationFailure: {
    error: true;
    errorMessage: string;
    errorNum: number;
}

Represents a bulk operation failure for an individual document.

+

Type declaration

  • error: true

    Indicates that the operation failed.

    +
  • errorMessage: string

    Human-readable description of the failure.

    +
  • errorNum: number

    Numeric representation of the failure.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.DocumentOperationMetadata.html b/9.0.0-preview.1/types/collection.DocumentOperationMetadata.html new file mode 100644 index 000000000..acc06de3b --- /dev/null +++ b/9.0.0-preview.1/types/collection.DocumentOperationMetadata.html @@ -0,0 +1,3 @@ +DocumentOperationMetadata | arangojs - v9.0.0-preview.1

Type alias DocumentOperationMetadata

DocumentOperationMetadata: DocumentMetadata & {
    _oldRev?: string;
}

Metadata returned by a document operation.

+

Type declaration

  • Optional _oldRev?: string

    Revision of the document that was updated or replaced by this operation.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.KeyGenerator.html b/9.0.0-preview.1/types/collection.KeyGenerator.html new file mode 100644 index 000000000..0d771966c --- /dev/null +++ b/9.0.0-preview.1/types/collection.KeyGenerator.html @@ -0,0 +1,2 @@ +KeyGenerator | arangojs - v9.0.0-preview.1

Type alias KeyGenerator

KeyGenerator: "traditional" | "autoincrement" | "uuid" | "padded"

Type of key generator.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SchemaOptions.html b/9.0.0-preview.1/types/collection.SchemaOptions.html new file mode 100644 index 000000000..07b0b15aa --- /dev/null +++ b/9.0.0-preview.1/types/collection.SchemaOptions.html @@ -0,0 +1,6 @@ +SchemaOptions | arangojs - v9.0.0-preview.1

Type alias SchemaOptions

SchemaOptions: {
    level?: ValidationLevel;
    message?: string;
    rule: any;
}

Options for validating collection documents.

+

Type declaration

  • Optional level?: ValidationLevel

    When validation should be applied.

    +

    Default: "strict"

    +
  • Optional message?: string

    Message to be used if validation fails.

    +
  • rule: any

    JSON Schema description of the validation schema for documents.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SchemaProperties.html b/9.0.0-preview.1/types/collection.SchemaProperties.html new file mode 100644 index 000000000..f3c4c8cf9 --- /dev/null +++ b/9.0.0-preview.1/types/collection.SchemaProperties.html @@ -0,0 +1,6 @@ +SchemaProperties | arangojs - v9.0.0-preview.1

Type alias SchemaProperties

SchemaProperties: {
    level: ValidationLevel;
    message: string;
    rule: any;
    type: "json";
}

Properties for validating documents in a collection.

+

Type declaration

  • level: ValidationLevel

    When validation should be applied.

    +
  • message: string

    Message to be used if validation fails.

    +
  • rule: any

    JSON Schema description of the validation schema for documents.

    +
  • type: "json"

    Type of document validation.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.ShardingStrategy.html b/9.0.0-preview.1/types/collection.ShardingStrategy.html new file mode 100644 index 000000000..b7a2146e5 --- /dev/null +++ b/9.0.0-preview.1/types/collection.ShardingStrategy.html @@ -0,0 +1,2 @@ +ShardingStrategy | arangojs - v9.0.0-preview.1

Type alias ShardingStrategy

ShardingStrategy: "hash" | "enterprise-hash-smart-edge" | "enterprise-hash-smart-vertex" | "community-compat" | "enterprise-compat" | "enterprise-smart-edge-compat"

Strategy for sharding a collection.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryAllOptions.html b/9.0.0-preview.1/types/collection.SimpleQueryAllOptions.html new file mode 100644 index 000000000..4b30130cf --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryAllOptions.html @@ -0,0 +1,15 @@ +SimpleQueryAllOptions | arangojs - v9.0.0-preview.1

Type alias SimpleQueryAllOptions

SimpleQueryAllOptions: {
    batchSize?: number;
    limit?: number;
    skip?: number;
    stream?: boolean;
    ttl?: number;
}

Options for retrieving all documents in a collection.

+

Type declaration

  • Optional batchSize?: number

    Number of result values to be transferred by the server in each +network roundtrip (or "batch").

    +

    Must be greater than zero.

    +

    See also database.QueryOptions.

    +
  • Optional limit?: number

    Maximum number of documents to return.

    +
  • Optional skip?: number

    Number of documents to skip in the query.

    +
  • Optional stream?: boolean

    If set to true, the query will be executed as a streaming query.

    +

    See also database.QueryOptions.

    +
  • Optional ttl?: number

    Time-to-live for the cursor in seconds. The cursor results may be +garbage collected by ArangoDB after this much time has passed.

    +

    See also database.QueryOptions.

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryByExampleOptions.html b/9.0.0-preview.1/types/collection.SimpleQueryByExampleOptions.html new file mode 100644 index 000000000..4552984ad --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryByExampleOptions.html @@ -0,0 +1,13 @@ +SimpleQueryByExampleOptions | arangojs - v9.0.0-preview.1

Type alias SimpleQueryByExampleOptions

SimpleQueryByExampleOptions: {
    batchSize?: number;
    limit?: number;
    skip?: number;
    ttl?: number;
}

Options for retrieving documents by example.

+

Type declaration

  • Optional batchSize?: number

    Number of result values to be transferred by the server in each +network roundtrip (or "batch").

    +

    Must be greater than zero.

    +

    See also database.QueryOptions.

    +
  • Optional limit?: number

    Maximum number of documents to return.

    +
  • Optional skip?: number

    Number of documents to skip in the query.

    +
  • Optional ttl?: number

    Time-to-live for the cursor in seconds. The cursor results may be +garbage collected by ArangoDB after this much time has passed.

    +

    See also database.QueryOptions.

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryFulltextOptions.html b/9.0.0-preview.1/types/collection.SimpleQueryFulltextOptions.html new file mode 100644 index 000000000..ba05e0256 --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryFulltextOptions.html @@ -0,0 +1,7 @@ +SimpleQueryFulltextOptions | arangojs - v9.0.0-preview.1

Type alias SimpleQueryFulltextOptions

SimpleQueryFulltextOptions: {
    index?: string;
    limit?: number;
    skip?: number;
}

Options for performing a fulltext query.

+

Type declaration

  • Optional index?: string

    Unique identifier of the fulltext index to use to perform the query.

    +
  • Optional limit?: number

    Maximum number of documents to return.

    +
  • Optional skip?: number

    Number of documents to skip in the query.

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryListType.html b/9.0.0-preview.1/types/collection.SimpleQueryListType.html new file mode 100644 index 000000000..72615a8b7 --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryListType.html @@ -0,0 +1,5 @@ +SimpleQueryListType | arangojs - v9.0.0-preview.1

Type alias SimpleQueryListType

SimpleQueryListType: "id" | "key" | "path"

Type of document reference.

+

See DocumentCollection#list and EdgeCollection#list.

+

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryRemoveByExampleOptions.html b/9.0.0-preview.1/types/collection.SimpleQueryRemoveByExampleOptions.html new file mode 100644 index 000000000..ac6ddc7fc --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryRemoveByExampleOptions.html @@ -0,0 +1,8 @@ +SimpleQueryRemoveByExampleOptions | arangojs - v9.0.0-preview.1

Type alias SimpleQueryRemoveByExampleOptions

SimpleQueryRemoveByExampleOptions: {
    limit?: number;
    waitForSync?: boolean;
}

Options for removing documents by example.

+

Type declaration

  • Optional limit?: number

    Maximum number of documents to return.

    +
  • Optional waitForSync?: boolean

    If set to true, the request will wait until all modifications have been +synchronized to disk before returning successfully.

    +

    Default: false

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryRemoveByExampleResult.html b/9.0.0-preview.1/types/collection.SimpleQueryRemoveByExampleResult.html new file mode 100644 index 000000000..f77442d53 --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryRemoveByExampleResult.html @@ -0,0 +1,6 @@ +SimpleQueryRemoveByExampleResult | arangojs - v9.0.0-preview.1

Type alias SimpleQueryRemoveByExampleResult

SimpleQueryRemoveByExampleResult: {
    deleted: number;
}

Result of removing documents by an example.

+

See DocumentCollection#removeByExample and EdgeCollection#removeByExample.

+

Type declaration

  • deleted: number

    Number of documents removed.

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryRemoveByKeysOptions.html b/9.0.0-preview.1/types/collection.SimpleQueryRemoveByKeysOptions.html new file mode 100644 index 000000000..f518c0077 --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryRemoveByKeysOptions.html @@ -0,0 +1,13 @@ +SimpleQueryRemoveByKeysOptions | arangojs - v9.0.0-preview.1

Type alias SimpleQueryRemoveByKeysOptions

SimpleQueryRemoveByKeysOptions: {
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}

Options for removing documents by keys.

+

Type declaration

  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • Optional silent?: boolean

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • Optional waitForSync?: boolean

    If set to true, the request will wait until all modifications have been +synchronized to disk before returning successfully.

    +

    Default: false

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryRemoveByKeysResult.html b/9.0.0-preview.1/types/collection.SimpleQueryRemoveByKeysResult.html new file mode 100644 index 000000000..a8b61af48 --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryRemoveByKeysResult.html @@ -0,0 +1,8 @@ +SimpleQueryRemoveByKeysResult | arangojs - v9.0.0-preview.1

Type alias SimpleQueryRemoveByKeysResult<T>

SimpleQueryRemoveByKeysResult<T>: {
    ignored: number;
    old?: DocumentMetadata[] | Document<T>[];
    removed: number;
}

Result of removing documents by keys.

+

See DocumentCollection#removeByKeys and EdgeCollection#removeByKeys.

+

Type Parameters

  • T extends Record<string, any> = any

Type declaration

  • ignored: number

    Number of documents not removed.

    +
  • Optional old?: DocumentMetadata[] | Document<T>[]

    Documents that have been removed.

    +
  • removed: number

    Number of documents removed.

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryReplaceByExampleOptions.html b/9.0.0-preview.1/types/collection.SimpleQueryReplaceByExampleOptions.html new file mode 100644 index 000000000..ded3730e7 --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryReplaceByExampleOptions.html @@ -0,0 +1,4 @@ +SimpleQueryReplaceByExampleOptions | arangojs - v9.0.0-preview.1

Type alias SimpleQueryReplaceByExampleOptions

SimpleQueryReplaceByExampleOptions: SimpleQueryRemoveByExampleOptions

Options for replacing documents by example.

+

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryReplaceByExampleResult.html b/9.0.0-preview.1/types/collection.SimpleQueryReplaceByExampleResult.html new file mode 100644 index 000000000..3dc71c732 --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryReplaceByExampleResult.html @@ -0,0 +1,6 @@ +SimpleQueryReplaceByExampleResult | arangojs - v9.0.0-preview.1

Type alias SimpleQueryReplaceByExampleResult

SimpleQueryReplaceByExampleResult: {
    replaced: number;
}

Result of replacing documents by an example.

+

See DocumentCollection#replaceByExample and EdgeCollection#replaceByExample.

+

Type declaration

  • replaced: number

    Number of documents replaced.

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryUpdateByExampleOptions.html b/9.0.0-preview.1/types/collection.SimpleQueryUpdateByExampleOptions.html new file mode 100644 index 000000000..d5734de0c --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryUpdateByExampleOptions.html @@ -0,0 +1,15 @@ +SimpleQueryUpdateByExampleOptions | arangojs - v9.0.0-preview.1

Type alias SimpleQueryUpdateByExampleOptions

SimpleQueryUpdateByExampleOptions: {
    keepNull?: boolean;
    limit?: number;
    mergeObjects?: boolean;
    waitForSync?: boolean;
}

Options for updating documents by example.

+

Type declaration

  • Optional keepNull?: boolean

    If set to false, properties with a value of null will be removed from +the new document.

    +

    Default: true

    +
  • Optional limit?: number

    Maximum number of documents to return.

    +
  • Optional mergeObjects?: boolean

    If set to false, object properties that already exist in the old +document will be overwritten rather than merged. This does not affect +arrays.

    +

    Default: true

    +
  • Optional waitForSync?: boolean

    If set to true, the request will wait until all modifications have been +synchronized to disk before returning successfully.

    +

    Default: false

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.SimpleQueryUpdateByExampleResult.html b/9.0.0-preview.1/types/collection.SimpleQueryUpdateByExampleResult.html new file mode 100644 index 000000000..5806384ac --- /dev/null +++ b/9.0.0-preview.1/types/collection.SimpleQueryUpdateByExampleResult.html @@ -0,0 +1,6 @@ +SimpleQueryUpdateByExampleResult | arangojs - v9.0.0-preview.1

Type alias SimpleQueryUpdateByExampleResult

SimpleQueryUpdateByExampleResult: {
    updated: number;
}

Result of updating documents by an example.

+

See DocumentCollection#updateByExample and EdgeCollection#updateByExample.

+

Type declaration

  • updated: number

    Number of documents updated.

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.TraversalOptions.html b/9.0.0-preview.1/types/collection.TraversalOptions.html new file mode 100644 index 000000000..7322256ea --- /dev/null +++ b/9.0.0-preview.1/types/collection.TraversalOptions.html @@ -0,0 +1,80 @@ +TraversalOptions | arangojs - v9.0.0-preview.1

Type alias TraversalOptions

TraversalOptions: {
    direction?: "inbound" | "outbound" | "any";
    expander?: string;
    filter?: string;
    init?: string;
    itemOrder?: "forward" | "backward";
    maxDepth?: number;
    maxIterations?: number;
    minDepth?: number;
    order?: "preorder" | "postorder" | "preorder-expander";
    sort?: string;
    strategy?: "depthfirst" | "breadthfirst";
    uniqueness?: {
        edges?: "none" | "global" | "path";
        vertices?: "none" | "global" | "path";
    };
    visitor?: string;
}

Options for performing a graph traversal.

+

Type declaration

  • Optional direction?: "inbound" | "outbound" | "any"

    Direction of the traversal, relative to the starting vertex if expander +is not set.

    +
  • Optional expander?: string

    A string evaluating to the body of a JavaScript function to be executed +on the server to use when direction is not set.

    +

    The code has access to three variables: config, vertex, path. +The code must return an array of objects with edge and vertex +attributes representing the connections for the vertex.

    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
  • Optional filter?: string

    A string evaluating to the body of a JavaScript function to be executed +on the server to filter nodes.

    +

    The code has access to three variables: config, vertex, path. +The code may include a return statement for the following values:

    +
      +
    • "exclude": The vertex will not be visited.
    • +
    • "prune": The edges of the vertex will not be followed.
    • +
    • "" or undefined: The vertex will be visited and its edges followed.
    • +
    • an array including any of the above values.
    • +
    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
  • Optional init?: string

    A string evaluating to the body of a JavaScript function to be executed +on the server to initialize the traversal result object.

    +

    The code has access to two variables: config, result. +The code may modify the result object.

    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
  • Optional itemOrder?: "forward" | "backward"

    Item iteration order.

    +
  • Optional maxDepth?: number

    If specified, only nodes in at most this depth will be visited.

    +
  • Optional maxIterations?: number

    Maximum number of iterations before a traversal is aborted because of a +potential endless loop.

    +
  • Optional minDepth?: number

    If specified, only nodes in at least this depth will be visited.

    +
  • Optional order?: "preorder" | "postorder" | "preorder-expander"

    Traversal order.

    +
  • Optional sort?: string

    A string evaluating to the body of a JavaScript function to be executed +on the server to sort edges if expander is not set.

    +

    The code has access to two variables representing edges: l, r. +The code must return -1 if l < r, 1 if l > r or 0 if both +values are equal.

    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
  • Optional strategy?: "depthfirst" | "breadthfirst"

    Traversal strategy.

    +
  • Optional uniqueness?: {
        edges?: "none" | "global" | "path";
        vertices?: "none" | "global" | "path";
    }

    Specifies uniqueness for vertices and edges.

    +
    • Optional edges?: "none" | "global" | "path"

      Uniqueness for edges.

      +
    • Optional vertices?: "none" | "global" | "path"

      Uniqueness for vertices.

      +
  • Optional visitor?: string

    A string evaluating to the body of a JavaScript function to be executed +on the server when a node is visited.

    +

    The code has access to five variables: config, result, vertex, +path, connected. +The code may modify the result object.

    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and are +no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.ValidationLevel.html b/9.0.0-preview.1/types/collection.ValidationLevel.html new file mode 100644 index 000000000..88442beb1 --- /dev/null +++ b/9.0.0-preview.1/types/collection.ValidationLevel.html @@ -0,0 +1,9 @@ +ValidationLevel | arangojs - v9.0.0-preview.1

Type alias ValidationLevel

ValidationLevel: "none" | "new" | "moderate" | "strict"

When a validation should be applied.

+
    +
  • "none": No validation.
  • +
  • "new": Newly inserted documents are validated.
  • +
  • "moderate": New and modified documents are validated unless the modified +document was already invalid.
  • +
  • "strict": New and modified documents are always validated.
  • +
+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/collection.WriteOperation.html b/9.0.0-preview.1/types/collection.WriteOperation.html new file mode 100644 index 000000000..802b732fb --- /dev/null +++ b/9.0.0-preview.1/types/collection.WriteOperation.html @@ -0,0 +1,2 @@ +WriteOperation | arangojs - v9.0.0-preview.1

Type alias WriteOperation

WriteOperation: "insert" | "update" | "replace"

Write operation that can result in a computed value being computed.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/connection.ArangoApiResponse.html b/9.0.0-preview.1/types/connection.ArangoApiResponse.html new file mode 100644 index 000000000..7eaa56288 --- /dev/null +++ b/9.0.0-preview.1/types/connection.ArangoApiResponse.html @@ -0,0 +1,2 @@ +ArangoApiResponse | arangojs - v9.0.0-preview.1

Type alias ArangoApiResponse<T>

ArangoApiResponse<T>: T & ArangoResponseMetadata

Extends the given base type T with the generic HTTP API response properties.

+

Type Parameters

  • T
\ No newline at end of file diff --git a/9.0.0-preview.1/types/connection.ArangoResponseMetadata.html b/9.0.0-preview.1/types/connection.ArangoResponseMetadata.html new file mode 100644 index 000000000..d7f4130c9 --- /dev/null +++ b/9.0.0-preview.1/types/connection.ArangoResponseMetadata.html @@ -0,0 +1,4 @@ +ArangoResponseMetadata | arangojs - v9.0.0-preview.1

Type alias ArangoResponseMetadata

ArangoResponseMetadata: {
    code: number;
    error: false;
}

Generic properties shared by all ArangoDB HTTP API responses.

+

Type declaration

  • code: number

    Response status code, typically 200.

    +
  • error: false

    Indicates that the request was successful.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/connection.BasicAuthCredentials.html b/9.0.0-preview.1/types/connection.BasicAuthCredentials.html new file mode 100644 index 000000000..c6f98bb09 --- /dev/null +++ b/9.0.0-preview.1/types/connection.BasicAuthCredentials.html @@ -0,0 +1,4 @@ +BasicAuthCredentials | arangojs - v9.0.0-preview.1

Type alias BasicAuthCredentials

BasicAuthCredentials: {
    password?: string;
    username: string;
}

Credentials for HTTP Basic authentication.

+

Type declaration

  • Optional password?: string

    Password to use for authentication. Defaults to an empty string.

    +
  • username: string

    Username to use for authentication, e.g. "root".

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/connection.BearerAuthCredentials.html b/9.0.0-preview.1/types/connection.BearerAuthCredentials.html new file mode 100644 index 000000000..346b80e13 --- /dev/null +++ b/9.0.0-preview.1/types/connection.BearerAuthCredentials.html @@ -0,0 +1,3 @@ +BearerAuthCredentials | arangojs - v9.0.0-preview.1

Type alias BearerAuthCredentials

BearerAuthCredentials: {
    token: string;
}

Credentials for HTTP Bearer token authentication.

+

Type declaration

  • token: string

    Bearer token to use for authentication.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/connection.Config.html b/9.0.0-preview.1/types/connection.Config.html new file mode 100644 index 000000000..a4bc8c8d5 --- /dev/null +++ b/9.0.0-preview.1/types/connection.Config.html @@ -0,0 +1,119 @@ +Config | arangojs - v9.0.0-preview.1

Type alias Config

Config: {
    afterResponse?: ((err, res?) => void);
    arangoVersion?: number;
    auth?: BasicAuthCredentials | BearerAuthCredentials;
    beforeRequest?: ((req) => void);
    credentials?: "omit" | "include" | "same-origin";
    databaseName?: string;
    headers?: Headers | Record<string, string>;
    keepalive?: boolean;
    loadBalancingStrategy?: LoadBalancingStrategy;
    maxRetries?: false | number;
    poolSize?: number;
    precaptureStackTraces?: boolean;
    responseQueueTimeSamples?: number;
    retryOnConflict?: number;
    url?: string | string[];
}

Options for configuring arangojs.

+

Type declaration

  • Optional afterResponse?: ((err, res?) => void)

    Callback that will be invoked when the server response has been received +and processed or when the request has been failed without a response.

    +

    The originating request will be available as the request property +on either the error or response object.

    +
      • (err, res?): void
      • Parameters

        • err: ArangojsError | null

          Error encountered when handling this request or null.

          +
        • Optional res: ArangojsResponse

          Response object for this request, if no error occurred.

          +

        Returns void

  • Optional arangoVersion?: number

    Numeric representation of the ArangoDB version the driver should expect. +The format is defined as XYYZZ where X is the major version, Y is +the zero-filled two-digit minor version and Z is the zero-filled two-digit +bugfix version, e.g. 30102 for 3.1.2, 20811 for 2.8.11.

    +

    Depending on this value certain methods may become unavailable or change +their behavior to remain compatible with different versions of ArangoDB.

    +

    Default: 31100

    +
  • Optional auth?: BasicAuthCredentials | BearerAuthCredentials

    Credentials to use for authentication.

    +

    See also database.Database#useBasicAuth and +database.Database#useBearerAuth.

    +

    Default: { username: "root", password: "" }

    +
  • Optional beforeRequest?: ((req) => void)

    Callback that will be invoked with the finished request object before it +is finalized. In the browser the request may already have been sent.

    +
      • (req): void
      • Parameters

        • req: globalThis.Request

          Request object or XHR instance used for this request.

          +

        Returns void

  • Optional credentials?: "omit" | "include" | "same-origin"

    (Browser only.) Determines whether credentials (e.g. cookies) will be sent +with requests to the ArangoDB server.

    +

    If set to same-origin, credentials will only be included with requests +on the same URL origin as the invoking script. If set to include, +credentials will always be sent. If set to omit, credentials will be +excluded from all requests.

    +

    Default: same-origin

    +
  • Optional databaseName?: string

    Name of the database to use.

    +

    Default: "_system"

    +
  • Optional headers?: Headers | Record<string, string>

    An object with additional headers to send with every request.

    +

    If an "authorization" header is provided, it will be overridden when +using database.Database#useBasicAuth, database.Database#useBearerAuth or +the auth configuration option.

    +
  • Optional keepalive?: boolean

    If set to true, requests will keep the underlying connection open until +it times out or is closed. In browsers this prevents requests from being +cancelled when the user navigates away from the page.

    +

    Default: true

    +
  • Optional loadBalancingStrategy?: LoadBalancingStrategy

    Determines the behavior when multiple URLs are provided:

    +
      +
    • "NONE": No load balancing. All requests will be handled by the first +URL in the list until a network error is encountered. On network error, +arangojs will advance to using the next URL in the list.

      +
    • +
    • "ONE_RANDOM": Randomly picks one URL from the list initially, then +behaves like "NONE".

      +
    • +
    • "ROUND_ROBIN": Every sequential request uses the next URL in the list.

      +
    • +
    +

    Default: "NONE"

    +
  • Optional maxRetries?: false | number

    Determines the behavior when a request fails because the underlying +connection to the server could not be opened +(i.e. ECONNREFUSED in Node.js):

    +
      +
    • false: the request fails immediately.

      +
    • +
    • 0: the request is retried until a server can be reached but only a +total number of times matching the number of known servers (including +the initial failed request).

      +
    • +
    • any other number: the request is retried until a server can be reached +or the request has been retried a total of maxRetries number of times +(not including the initial failed request).

      +
    • +
    +

    When working with a single server, the retries (if any) will be made to +the same server.

    +

    This setting currently has no effect when using arangojs in a browser.

    +

    Note: Requests bound to a specific server (e.g. fetching query results) +will never be retried automatically and ignore this setting.

    +

    Note: To set the number of retries when a write-write conflict is +encountered, see retryOnConflict instead.

    +

    Default: 0

    +
  • Optional poolSize?: number

    Maximum number of parallel requests arangojs will perform. If any +additional requests are attempted, they will be enqueued until one of the +active requests has completed.

    +

    Note: when using ROUND_ROBIN load balancing and passing an array of +URLs in the url option, the default value of this option will be set to +3 * url.length instead of 3.

    +

    Default: 3

    +
  • Optional precaptureStackTraces?: boolean

    If set to true, arangojs will generate stack traces every time a request +is initiated and augment the stack traces of any errors it generates.

    +

    Warning: This will cause arangojs to generate stack traces in advance +even if the request does not result in an error. Generating stack traces +may negatively impact performance.

    +
  • Optional responseQueueTimeSamples?: number

    Limits the number of values of server-reported response queue times that +will be stored and accessible using database.Database#queueTime. If set to +a finite value, older values will be discarded to make room for new values +when that limit is reached.

    +

    Default: 10

    +
  • Optional retryOnConflict?: number

    If set to a positive number, requests will automatically be retried at +most this many times if they result in a write-write conflict.

    +

    Default: 0

    +
  • Optional url?: string | string[]

    Base URL of the ArangoDB server or list of server URLs.

    +

    When working with a cluster, the method database.Database#acquireHostList +can be used to automatically pick up additional coordinators/followers at +any point.

    +

    When running ArangoDB on a unix socket, e.g. /tmp/arangodb.sock, the +following URL formats are supported for unix sockets:

    +
      +
    • unix:///tmp/arangodb.sock (no SSL)
    • +
    • http+unix:///tmp/arangodb.sock (or https+unix:// for SSL)
    • +
    • http://unix:/tmp/arangodb.sock (or https://unix: for SSL)
    • +
    +

    Additionally ssl and tls are treated as synonymous with https and +tcp is treated as synonymous with http, so the following URLs are +considered identical:

    +
      +
    • tcp://127.0.0.1:8529 and http://127.0.0.1:8529
    • +
    • ssl://127.0.0.1:8529 and https://127.0.0.1:8529
    • +
    • tcp+unix:///tmp/arangodb.sock and http+unix:///tmp/arangodb.sock
    • +
    • ssl+unix:///tmp/arangodb.sock and https+unix:///tmp/arangodb.sock
    • +
    • tcp://unix:/tmp/arangodb.sock and http://unix:/tmp/arangodb.sock
    • +
    • ssl://unix:/tmp/arangodb.sock and https://unix:/tmp/arangodb.sock
    • +
    +

    See also auth for passing authentication credentials.

    +

    Default: "http://127.0.0.1:8529"

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/connection.LoadBalancingStrategy.html b/9.0.0-preview.1/types/connection.LoadBalancingStrategy.html new file mode 100644 index 000000000..df0ff3df0 --- /dev/null +++ b/9.0.0-preview.1/types/connection.LoadBalancingStrategy.html @@ -0,0 +1,13 @@ +LoadBalancingStrategy | arangojs - v9.0.0-preview.1

Type alias LoadBalancingStrategy

LoadBalancingStrategy: "NONE" | "ROUND_ROBIN" | "ONE_RANDOM"

Determines the behavior when multiple URLs are used:

+
    +
  • "NONE": No load balancing. All requests will be handled by the first +URL in the list until a network error is encountered. On network error, +arangojs will advance to using the next URL in the list.

    +
  • +
  • "ONE_RANDOM": Randomly picks one URL from the list initially, then +behaves like "NONE".

    +
  • +
  • "ROUND_ROBIN": Every sequential request uses the next URL in the list.

    +
  • +
+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/connection.RequestOptions.html b/9.0.0-preview.1/types/connection.RequestOptions.html new file mode 100644 index 000000000..388ec66b5 --- /dev/null +++ b/9.0.0-preview.1/types/connection.RequestOptions.html @@ -0,0 +1,23 @@ +RequestOptions | arangojs - v9.0.0-preview.1

Type alias RequestOptions

RequestOptions: {
    allowDirtyRead?: boolean;
    basePath?: string;
    body?: any;
    expectBinary?: boolean;
    headers?: Headers | Record<string, string>;
    isBinary?: boolean;
    method?: string;
    path?: string;
    retryOnConflict?: number;
    search?: URLSearchParams | Record<string, any>;
    timeout?: number;
}

Options for performing a request with arangojs.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    Whether ArangoDB is allowed to perform a dirty read to respond to this +request. If set to true, the response may reflect a dirty state from +a non-authoritative server.

    +
  • Optional basePath?: string

    Optional prefix path to prepend to the path.

    +
  • Optional body?: any

    Request body data.

    +
  • Optional expectBinary?: boolean

    If set to true, the response body will not be interpreted as JSON and +instead passed as-is.

    +
  • Optional headers?: Headers | Record<string, string>

    HTTP headers to pass along with this request in addition to the default +headers generated by arangojs.

    +
  • Optional isBinary?: boolean

    If set to true, the request body will not be converted to JSON and +instead passed as-is.

    +
  • Optional method?: string

    HTTP method to use in order to perform the request.

    +

    Default: "GET"

    +
  • Optional path?: string

    URL path, relative to the basePath and server domain.

    +
  • Optional retryOnConflict?: number

    If set to a positive number, the request will automatically be retried at +most this many times if it results in a write-write conflict.

    +

    Default: config.retryOnConflict

    +
  • Optional search?: URLSearchParams | Record<string, any>

    URL parameters to pass as part of the query string.

    +
  • Optional timeout?: number

    Time in milliseconds after which arangojs will abort the request if the +socket has not already timed out.

    +

    See also agentOptions.timeout in Config.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.AccessLevel.html b/9.0.0-preview.1/types/database.AccessLevel.html new file mode 100644 index 000000000..6af536d5b --- /dev/null +++ b/9.0.0-preview.1/types/database.AccessLevel.html @@ -0,0 +1,2 @@ +AccessLevel | arangojs - v9.0.0-preview.1

Type alias AccessLevel

AccessLevel: "rw" | "ro" | "none"

Access level for an ArangoDB user's access to a collection or database.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.AqlUserFunction.html b/9.0.0-preview.1/types/database.AqlUserFunction.html new file mode 100644 index 000000000..4c343b25a --- /dev/null +++ b/9.0.0-preview.1/types/database.AqlUserFunction.html @@ -0,0 +1,6 @@ +AqlUserFunction | arangojs - v9.0.0-preview.1

Type alias AqlUserFunction

AqlUserFunction: {
    code: string;
    isDeterministic: boolean;
    name: string;
}

Definition of an AQL User Function.

+

Type declaration

  • code: string

    Implementation of the AQL User Function.

    +
  • isDeterministic: boolean

    Whether the function is deterministic.

    +

    See Database#createFunction.

    +
  • name: string

    Name of the AQL User Function.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ArangoUser.html b/9.0.0-preview.1/types/database.ArangoUser.html new file mode 100644 index 000000000..893d8ef94 --- /dev/null +++ b/9.0.0-preview.1/types/database.ArangoUser.html @@ -0,0 +1,5 @@ +ArangoUser | arangojs - v9.0.0-preview.1

Type alias ArangoUser

ArangoUser: {
    active: boolean;
    extra: Record<string, any>;
    user: string;
}

Properties of an ArangoDB user object.

+

Type declaration

  • active: boolean

    Whether the ArangoDB user account is enabled and can authenticate.

    +
  • extra: Record<string, any>

    Additional information to store about this user.

    +
  • user: string

    ArangoDB username of the user.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.AstNode.html b/9.0.0-preview.1/types/database.AstNode.html new file mode 100644 index 000000000..9f90cfa29 --- /dev/null +++ b/9.0.0-preview.1/types/database.AstNode.html @@ -0,0 +1,2 @@ +AstNode | arangojs - v9.0.0-preview.1

Type alias AstNode

AstNode: {
    subNodes: AstNode[];
    type: string;
    [key: string]: any;
}

Node in an AQL abstract syntax tree (AST).

+

Type declaration

  • [key: string]: any
  • subNodes: AstNode[]
  • type: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ClusterImbalanceInfo.html b/9.0.0-preview.1/types/database.ClusterImbalanceInfo.html new file mode 100644 index 000000000..c6cf4f510 --- /dev/null +++ b/9.0.0-preview.1/types/database.ClusterImbalanceInfo.html @@ -0,0 +1,18 @@ +ClusterImbalanceInfo | arangojs - v9.0.0-preview.1

Type alias ClusterImbalanceInfo

ClusterImbalanceInfo: {
    leader: {
        imbalance: number;
        leaderDupl: number[];
        numberShards: number[];
        targetWeight: number[];
        totalShards: number;
        totalWeight: number;
        weightUsed: number[];
    };
    shards: {
        imbalance: number;
        numberShards: number[];
        sizeUsed: number[];
        targetSize: number[];
        totalShards: number;
        totalShardsFromSystemCollections: number;
        totalUsed: number;
    };
}

Information about a cluster imbalance.

+

Type declaration

  • leader: {
        imbalance: number;
        leaderDupl: number[];
        numberShards: number[];
        targetWeight: number[];
        totalShards: number;
        totalWeight: number;
        weightUsed: number[];
    }

    Information about the leader imbalance.

    +
    • imbalance: number

      The measure of the total imbalance. A high value indicates a high imbalance.

      +
    • leaderDupl: number[]

      The measure of the leader shard distribution. The higher the number, the worse the distribution.

      +
    • numberShards: number[]

      The number of leader shards per DB-Server.

      +
    • targetWeight: number[]

      The ideal weight of leader shards per DB-Server.

      +
    • totalShards: number

      The sum of shards, counting leader shards only.

      +
    • totalWeight: number

      The sum of all weights.

      +
    • weightUsed: number[]

      The weight of leader shards per DB-Server. A leader has a weight of 1 by default but it is higher if collections can only be moved together because of distributeShardsLike.

      +
  • shards: {
        imbalance: number;
        numberShards: number[];
        sizeUsed: number[];
        targetSize: number[];
        totalShards: number;
        totalShardsFromSystemCollections: number;
        totalUsed: number;
    }

    Information about the shard imbalance.

    +
    • imbalance: number

      The measure of the total imbalance. A high value indicates a high imbalance.

      +
    • numberShards: number[]

      The number of leader and follower shards per DB-Server.

      +
    • sizeUsed: number[]

      The size of shards per DB-Server.

      +
    • targetSize: number[]

      The ideal size of shards per DB-Server.

      +
    • totalShards: number

      The sum of shards, counting leader and follower shards.

      +
    • totalShardsFromSystemCollections: number

      The sum of system collection shards, counting leader shards only.

      +
    • totalUsed: number

      The sum of the sizes.

      +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ClusterRebalanceMove.html b/9.0.0-preview.1/types/database.ClusterRebalanceMove.html new file mode 100644 index 000000000..204d8ef13 --- /dev/null +++ b/9.0.0-preview.1/types/database.ClusterRebalanceMove.html @@ -0,0 +1,6 @@ +ClusterRebalanceMove | arangojs - v9.0.0-preview.1

Type alias ClusterRebalanceMove

ClusterRebalanceMove: {
    collection: number;
    from: string;
    isLeader: boolean;
    shard: string;
    to: string;
}

Type declaration

  • collection: number

    Collection ID of the collection the shard belongs to.

    +
  • from: string

    The server name from which to move.

    +
  • isLeader: boolean

    True if this is a leader move shard operation.

    +
  • shard: string

    Shard ID of the shard to be moved.

    +
  • to: string

    The ID of the destination server.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ClusterRebalanceOptions.html b/9.0.0-preview.1/types/database.ClusterRebalanceOptions.html new file mode 100644 index 000000000..94354a843 --- /dev/null +++ b/9.0.0-preview.1/types/database.ClusterRebalanceOptions.html @@ -0,0 +1,15 @@ +ClusterRebalanceOptions | arangojs - v9.0.0-preview.1

Type alias ClusterRebalanceOptions

ClusterRebalanceOptions: {
    databasesExcluded?: string[];
    excludeSystemCollections?: boolean;
    leaderChanges?: boolean;
    maximumNumberOfMoves?: number;
    moveFollowers?: boolean;
    moveLeaders?: boolean;
    piFactor?: number;
}

Options for rebalancing the cluster.

+

Type declaration

  • Optional databasesExcluded?: string[]

    A list of database names to exclude from the analysis.

    +

    Default: []

    +
  • Optional excludeSystemCollections?: boolean

    Ignore system collections in the rebalance plan.

    +

    Default: false

    +
  • Optional leaderChanges?: boolean

    Allow leader changes without moving data.

    +

    Default: true

    +
  • Optional maximumNumberOfMoves?: number

    Maximum number of moves to be computed.

    +

    Default: 1000

    +
  • Optional moveFollowers?: boolean

    Allow moving followers.

    +

    Default: false

    +
  • Optional moveLeaders?: boolean

    Allow moving leaders.

    +

    Default: false

    +
  • Optional piFactor?: number

    Default: 256**6

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ClusterRebalanceResult.html b/9.0.0-preview.1/types/database.ClusterRebalanceResult.html new file mode 100644 index 000000000..6e7646696 --- /dev/null +++ b/9.0.0-preview.1/types/database.ClusterRebalanceResult.html @@ -0,0 +1,4 @@ +ClusterRebalanceResult | arangojs - v9.0.0-preview.1

Type alias ClusterRebalanceResult

ClusterRebalanceResult: {
    imbalanceAfter: ClusterImbalanceInfo;
    imbalanceBefore: ClusterImbalanceInfo;
    moves: ClusterRebalanceMove[];
}

Type declaration

\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ClusterRebalanceState.html b/9.0.0-preview.1/types/database.ClusterRebalanceState.html new file mode 100644 index 000000000..423110315 --- /dev/null +++ b/9.0.0-preview.1/types/database.ClusterRebalanceState.html @@ -0,0 +1,4 @@ +ClusterRebalanceState | arangojs - v9.0.0-preview.1

Type alias ClusterRebalanceState

ClusterRebalanceState: ClusterImbalanceInfo & {
    pendingMoveShards: number;
    todoMoveShards: number;
}

Information about the current state of the cluster imbalance.

+

Type declaration

  • pendingMoveShards: number

    The number of pending move shard operations.

    +
  • todoMoveShards: number

    The number of planned move shard operations.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.CreateDatabaseOptions.html b/9.0.0-preview.1/types/database.CreateDatabaseOptions.html new file mode 100644 index 000000000..b54762c1b --- /dev/null +++ b/9.0.0-preview.1/types/database.CreateDatabaseOptions.html @@ -0,0 +1,12 @@ +CreateDatabaseOptions | arangojs - v9.0.0-preview.1

Type alias CreateDatabaseOptions

CreateDatabaseOptions: {
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    users?: CreateDatabaseUser[];
    writeConcern?: number;
}

Options for creating a database.

+

See Database#createDatabase.

+

Type declaration

  • Optional replicationFactor?: "satellite" | number

    (Cluster only.) Default replication factor for new collections in this +database.

    +

    Setting this to 1 disables replication. Setting this to "satellite" +will replicate to every DBServer.

    +
  • Optional sharding?: "" | "flexible" | "single"

    (Cluster only.) The sharding method to use for new collections in the +database.

    +
  • Optional users?: CreateDatabaseUser[]

    Database users to create with the database.

    +
  • Optional writeConcern?: number

    (Cluster only.) Default write concern for new collections created in this +database.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.CreateDatabaseUser.html b/9.0.0-preview.1/types/database.CreateDatabaseUser.html new file mode 100644 index 000000000..96d3fb7e6 --- /dev/null +++ b/9.0.0-preview.1/types/database.CreateDatabaseUser.html @@ -0,0 +1,8 @@ +CreateDatabaseUser | arangojs - v9.0.0-preview.1

Type alias CreateDatabaseUser

CreateDatabaseUser: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd?: string;
    username: string;
}

Database user to create with a database.

+

Type declaration

  • Optional active?: boolean

    Whether the user is active.

    +

    Default: true

    +
  • Optional extra?: Record<string, any>

    Additional data to store with the user object.

    +
  • Optional passwd?: string

    Password of the user to create.

    +

    Default: ""

    +
  • username: string

    Username of the user to create.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.CreateUserOptions.html b/9.0.0-preview.1/types/database.CreateUserOptions.html new file mode 100644 index 000000000..6868cdc4e --- /dev/null +++ b/9.0.0-preview.1/types/database.CreateUserOptions.html @@ -0,0 +1,8 @@ +CreateUserOptions | arangojs - v9.0.0-preview.1

Type alias CreateUserOptions

CreateUserOptions: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
    user: string;
}

Options for creating an ArangoDB user.

+

Type declaration

  • Optional active?: boolean

    Whether the ArangoDB user account is enabled and can authenticate.

    +

    Default: true

    +
  • Optional extra?: Record<string, any>

    Additional information to store about this user.

    +

    Default: {}

    +
  • passwd: string

    Password the ArangoDB user will use for authentication.

    +
  • user: string

    ArangoDB username of the user.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.DatabaseInfo.html b/9.0.0-preview.1/types/database.DatabaseInfo.html new file mode 100644 index 000000000..9de766557 --- /dev/null +++ b/9.0.0-preview.1/types/database.DatabaseInfo.html @@ -0,0 +1,13 @@ +DatabaseInfo | arangojs - v9.0.0-preview.1

Type alias DatabaseInfo

DatabaseInfo: {
    id: string;
    isSystem: boolean;
    name: string;
    path: string;
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    writeConcern?: number;
}

Object describing a database.

+

See Database#get.

+

Type declaration

  • id: string

    Unique identifier of the database.

    +
  • isSystem: boolean

    Whether the database is the system database.

    +
  • name: string

    Name of the database.

    +
  • path: string

    File system path of the database.

    +
  • Optional replicationFactor?: "satellite" | number

    (Cluster only.) Default replication factor for new collections in this +database.

    +
  • Optional sharding?: "" | "flexible" | "single"

    (Cluster only.) The sharding method to use for new collections in the +database.

    +
  • Optional writeConcern?: number

    (Cluster only.) Default write concern for new collections created in this +database.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ExplainOptions.html b/9.0.0-preview.1/types/database.ExplainOptions.html new file mode 100644 index 000000000..28cf82ae0 --- /dev/null +++ b/9.0.0-preview.1/types/database.ExplainOptions.html @@ -0,0 +1,13 @@ +ExplainOptions | arangojs - v9.0.0-preview.1

Type alias ExplainOptions

ExplainOptions: {
    allPlans?: boolean;
    maxNumberOfPlans?: number;
    optimizer?: {
        rules: string[];
    };
}

Options for explaining a query.

+

See Database#explain.

+

Type declaration

  • Optional allPlans?: boolean

    If set to true, all possible execution plans will be returned as the +plans property. Otherwise only the optimal execution plan will be +returned as the plan property.

    +

    Default: false

    +
  • Optional maxNumberOfPlans?: number

    Maximum number of plans that the optimizer is allowed to generate. +Setting this to a low value limits the amount of work the optimizer does.

    +
  • Optional optimizer?: {
        rules: string[];
    }

    An object with a rules property specifying a list of optimizer rules to +be included or excluded by the optimizer for this query. Prefix a rule +name with + to include it, or - to exclude it. The name all acts as +an alias matching all optimizer rules.

    +
    • rules: string[]
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ExplainPlan.html b/9.0.0-preview.1/types/database.ExplainPlan.html new file mode 100644 index 000000000..c845a98db --- /dev/null +++ b/9.0.0-preview.1/types/database.ExplainPlan.html @@ -0,0 +1,9 @@ +ExplainPlan | arangojs - v9.0.0-preview.1

Type alias ExplainPlan

ExplainPlan: {
    collections: {
        name: string;
        type: "read" | "write";
    }[];
    estimatedCost: number;
    estimatedNrItems: number;
    isModificationQuery: boolean;
    nodes: {
        dependencies: number[];
        estimatedCost: number;
        estimatedNrItems: number;
        id: number;
        type: string;
        [key: string]: any;
    }[];
    rules: string[];
    variables: {
        id: number;
        name: string;
    }[];
}

Plan explaining query execution.

+

Type declaration

  • collections: {
        name: string;
        type: "read" | "write";
    }[]

    Information about collections involved in the query.

    +
  • estimatedCost: number

    Total estimated cost of the plan.

    +
  • estimatedNrItems: number

    Estimated number of items returned by the query.

    +
  • isModificationQuery: boolean

    Whether the query is a data modification query.

    +
  • nodes: {
        dependencies: number[];
        estimatedCost: number;
        estimatedNrItems: number;
        id: number;
        type: string;
        [key: string]: any;
    }[]

    Execution nodes in this plan.

    +
  • rules: string[]

    Rules applied by the optimizer.

    +
  • variables: {
        id: number;
        name: string;
    }[]

    Variables used in the query.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ExplainStats.html b/9.0.0-preview.1/types/database.ExplainStats.html new file mode 100644 index 000000000..873b75c3c --- /dev/null +++ b/9.0.0-preview.1/types/database.ExplainStats.html @@ -0,0 +1,7 @@ +ExplainStats | arangojs - v9.0.0-preview.1

Type alias ExplainStats

ExplainStats: {
    executionTime: number;
    peakMemoryUsage: number;
    plansCreated: number;
    rulesExecuted: number;
    rulesSkipped: number;
}

Optimizer statistics for an explained query.

+

Type declaration

  • executionTime: number

    Time in seconds needed to explain the query.

    +
  • peakMemoryUsage: number

    Maximum memory usage in bytes of the query during explain.

    +
  • plansCreated: number

    Total number of plans created.

    +
  • rulesExecuted: number

    Total number of rules executed for this query.

    +
  • rulesSkipped: number

    Number of rules skipped for this query.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.HotBackupList.html b/9.0.0-preview.1/types/database.HotBackupList.html new file mode 100644 index 000000000..d0bac7752 --- /dev/null +++ b/9.0.0-preview.1/types/database.HotBackupList.html @@ -0,0 +1,2 @@ +HotBackupList | arangojs - v9.0.0-preview.1

Type alias HotBackupList

HotBackupList: {
    list: Record<string, HotBackupResult & {
        available: boolean;
        countIncludesFilesOnly: boolean;
        keys: any[];
        nrPiecesPresent: number;
        version: string;
    }>;
    server: string;
}

(Enterprise Edition only.) List of known hot backups.

+

Type declaration

  • list: Record<string, HotBackupResult & {
        available: boolean;
        countIncludesFilesOnly: boolean;
        keys: any[];
        nrPiecesPresent: number;
        version: string;
    }>
  • server: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.HotBackupOptions.html b/9.0.0-preview.1/types/database.HotBackupOptions.html new file mode 100644 index 000000000..e3116e173 --- /dev/null +++ b/9.0.0-preview.1/types/database.HotBackupOptions.html @@ -0,0 +1,15 @@ +HotBackupOptions | arangojs - v9.0.0-preview.1

Type alias HotBackupOptions

HotBackupOptions: {
    allowInconsistent?: boolean;
    force?: boolean;
    label?: string;
    timeout?: number;
}

(Enterprise Edition only.) Options for creating a hot backup.

+

Type declaration

  • Optional allowInconsistent?: boolean

    If set to true and no global transaction lock can be acquired within the +given timeout, a possibly inconsistent backup is taken.

    +

    Default: false

    +
  • Optional force?: boolean

    (Enterprise Edition cluster only.) If set to true and no global +transaction lock can be acquired within the given timeout, all running +transactions are forcefully aborted to ensure that a consistent backup +can be created.

    +

    Default: false.

    +
  • Optional label?: string

    Label to appended to the backup's identifier.

    +

    Default: If omitted or empty, a UUID will be generated.

    +
  • Optional timeout?: number

    Time in seconds that the operation will attempt to get a consistent +snapshot.

    +

    Default: 120.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.HotBackupResult.html b/9.0.0-preview.1/types/database.HotBackupResult.html new file mode 100644 index 000000000..765c66071 --- /dev/null +++ b/9.0.0-preview.1/types/database.HotBackupResult.html @@ -0,0 +1,2 @@ +HotBackupResult | arangojs - v9.0.0-preview.1

Type alias HotBackupResult

HotBackupResult: {
    datetime: string;
    id: string;
    nrDBServers: number;
    nrFiles: number;
    potentiallyInconsistent: boolean;
    sizeInBytes: number;
}

(Enterprise Edition only.) Result of a hot backup.

+

Type declaration

  • datetime: string
  • id: string
  • nrDBServers: number
  • nrFiles: number
  • potentiallyInconsistent: boolean
  • sizeInBytes: number
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.InstallServiceOptions.html b/9.0.0-preview.1/types/database.InstallServiceOptions.html new file mode 100644 index 000000000..6aec1cae7 --- /dev/null +++ b/9.0.0-preview.1/types/database.InstallServiceOptions.html @@ -0,0 +1,15 @@ +InstallServiceOptions | arangojs - v9.0.0-preview.1

Type alias InstallServiceOptions

InstallServiceOptions: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    legacy?: boolean;
    setup?: boolean;
}

Options for installing the service.

+

See Database#installService.

+

Type declaration

  • Optional configuration?: Record<string, any>

    An object mapping configuration option names to values.

    +

    See also Database#getServiceConfiguration.

    +
  • Optional dependencies?: Record<string, string>

    An object mapping dependency aliases to mount points.

    +

    See also Database#getServiceDependencies.

    +
  • Optional development?: boolean

    Whether the service should be installed in development mode.

    +

    See also Database#setServiceDevelopmentMode.

    +

    Default: false

    +
  • Optional legacy?: boolean

    Whether the service should be installed in legacy compatibility mode

    +

    This overrides the engines option in the service manifest (if any).

    +

    Default: false

    +
  • Optional setup?: boolean

    Whether the "setup" script should be executed.

    +

    Default: true

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.LogEntries.html b/9.0.0-preview.1/types/database.LogEntries.html new file mode 100644 index 000000000..e21f5c50d --- /dev/null +++ b/9.0.0-preview.1/types/database.LogEntries.html @@ -0,0 +1,2 @@ +LogEntries | arangojs - v9.0.0-preview.1

Type alias LogEntries

LogEntries: {
    level: LogLevel[];
    lid: number[];
    text: string[];
    timestamp: number[];
    topic: string[];
    totalAmount: number;
}

An object representing a list of log entries.

+

Type declaration

  • level: LogLevel[]
  • lid: number[]
  • text: string[]
  • timestamp: number[]
  • topic: string[]
  • totalAmount: number
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.LogEntriesOptions.html b/9.0.0-preview.1/types/database.LogEntriesOptions.html new file mode 100644 index 000000000..021815d9b --- /dev/null +++ b/9.0.0-preview.1/types/database.LogEntriesOptions.html @@ -0,0 +1,13 @@ +LogEntriesOptions | arangojs - v9.0.0-preview.1

Type alias LogEntriesOptions

LogEntriesOptions: {
    level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
    offset?: number;
    search?: string;
    size?: number;
    sort?: LogSortDirection;
    start?: number;
    upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
}

Options for retrieving log entries.

+

Type declaration

  • Optional level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>

    If set, only log entries with this log level will be returned.

    +
  • Optional offset?: number

    If set, this many log entries will be skipped.

    +
  • Optional search?: string

    If set, only log entries containing the specified text will be returned.

    +
  • Optional size?: number

    If set, only this many entries will be returned.

    +
  • Optional sort?: LogSortDirection

    If set to "desc", log entries will be returned in reverse chronological +order.

    +

    Default: "asc".

    +
  • Optional start?: number

    If set, only log entries with an lid greater than or equal to this value +will be returned.

    +
  • Optional upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>

    Maximum log level of the entries to retrieve.

    +

    Default: INFO.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.LogLevelLabel.html b/9.0.0-preview.1/types/database.LogLevelLabel.html new file mode 100644 index 000000000..992e6c336 --- /dev/null +++ b/9.0.0-preview.1/types/database.LogLevelLabel.html @@ -0,0 +1,2 @@ +LogLevelLabel | arangojs - v9.0.0-preview.1

Type alias LogLevelLabel

LogLevelLabel: "FATAL" | "ERROR" | "WARNING" | "INFO" | "DEBUG"

String representation of the logging level of a log entry.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.LogLevelSetting.html b/9.0.0-preview.1/types/database.LogLevelSetting.html new file mode 100644 index 000000000..473d9146b --- /dev/null +++ b/9.0.0-preview.1/types/database.LogLevelSetting.html @@ -0,0 +1,2 @@ +LogLevelSetting | arangojs - v9.0.0-preview.1

Type alias LogLevelSetting

LogLevelSetting: LogLevelLabel | "DEFAULT"

Logging level setting.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.LogMessage.html b/9.0.0-preview.1/types/database.LogMessage.html new file mode 100644 index 000000000..2d20bab4e --- /dev/null +++ b/9.0.0-preview.1/types/database.LogMessage.html @@ -0,0 +1,2 @@ +LogMessage | arangojs - v9.0.0-preview.1

Type alias LogMessage

LogMessage: {
    date: string;
    id: number;
    level: LogLevelLabel;
    message: string;
    topic: string;
}

An object representing a single log entry.

+

Type declaration

  • date: string
  • id: number
  • level: LogLevelLabel
  • message: string
  • topic: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.LogSortDirection.html b/9.0.0-preview.1/types/database.LogSortDirection.html new file mode 100644 index 000000000..46da6be70 --- /dev/null +++ b/9.0.0-preview.1/types/database.LogSortDirection.html @@ -0,0 +1,2 @@ +LogSortDirection | arangojs - v9.0.0-preview.1

Type alias LogSortDirection

LogSortDirection: "asc" | "desc"

Log sorting direction, ascending or descending.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.MultiExplainResult.html b/9.0.0-preview.1/types/database.MultiExplainResult.html new file mode 100644 index 000000000..454fdac8f --- /dev/null +++ b/9.0.0-preview.1/types/database.MultiExplainResult.html @@ -0,0 +1,6 @@ +MultiExplainResult | arangojs - v9.0.0-preview.1

Type alias MultiExplainResult

MultiExplainResult: {
    cacheable: boolean;
    plans: ExplainPlan[];
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}

Result of explaining a query with multiple plans.

+

Type declaration

  • cacheable: boolean

    Whether it would be possible to cache the query.

    +
  • plans: ExplainPlan[]

    Query plans.

    +
  • stats: ExplainStats

    Optimizer statistics for the explained query.

    +
  • warnings: {
        code: number;
        message: string;
    }[]

    Warnings encountered while planning the query execution.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.MultiServiceDependency.html b/9.0.0-preview.1/types/database.MultiServiceDependency.html new file mode 100644 index 000000000..b7ae820be --- /dev/null +++ b/9.0.0-preview.1/types/database.MultiServiceDependency.html @@ -0,0 +1,10 @@ +MultiServiceDependency | arangojs - v9.0.0-preview.1

Type alias MultiServiceDependency

MultiServiceDependency: {
    current?: string[];
    description?: string;
    multiple: true;
    name: string;
    required: boolean;
    title: string;
    version: string;
}

Object describing a multi-service dependency defined by a Foxx service.

+

Type declaration

  • Optional current?: string[]

    Current mount points the dependency is resolved to.

    +
  • Optional description?: string

    Human-readable description of the dependency.

    +
  • multiple: true

    Whether this is a multi-service dependency.

    +
  • name: string

    Name of the service the dependency expects to match.

    +
  • required: boolean

    Whether the dependency must be matched in order for the service +to be operational.

    +
  • title: string

    Formatted name of the dependency.

    +
  • version: string

    Version of the service the dependency expects to match.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ParseResult.html b/9.0.0-preview.1/types/database.ParseResult.html new file mode 100644 index 000000000..9f374237c --- /dev/null +++ b/9.0.0-preview.1/types/database.ParseResult.html @@ -0,0 +1,6 @@ +ParseResult | arangojs - v9.0.0-preview.1

Type alias ParseResult

ParseResult: {
    ast: AstNode[];
    bindVars: string[];
    collections: string[];
    parsed: boolean;
}

Result of parsing a query.

+

Type declaration

  • ast: AstNode[]

    Abstract syntax tree (AST) of the query.

    +
  • bindVars: string[]

    Names of all bind parameters used in the query.

    +
  • collections: string[]

    Names of all collections involved in the query.

    +
  • parsed: boolean

    Whether the query was parsed.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.QueryInfo.html b/9.0.0-preview.1/types/database.QueryInfo.html new file mode 100644 index 000000000..21ae7c2b5 --- /dev/null +++ b/9.0.0-preview.1/types/database.QueryInfo.html @@ -0,0 +1,12 @@ +QueryInfo | arangojs - v9.0.0-preview.1

Type alias QueryInfo

QueryInfo: {
    bindVars: Record<string, any>;
    database: string;
    id: string;
    peakMemoryUsage: number;
    query: string;
    runTime: number;
    started: string;
    state: "executing" | "finished" | "killed";
    stream: boolean;
    user: string;
}

Object describing a query.

+

Type declaration

  • bindVars: Record<string, any>

    Bind parameters used in the query.

    +
  • database: string

    Name of the database the query runs in.

    +
  • id: string

    Unique identifier for this query.

    +
  • peakMemoryUsage: number

    Maximum memory usage in bytes of the query.

    +
  • query: string

    Query string (potentially truncated).

    +
  • runTime: number

    Query's running time in seconds.

    +
  • started: string

    Date and time the query was started.

    +
  • state: "executing" | "finished" | "killed"

    Query's current execution state.

    +
  • stream: boolean

    Whether the query uses a streaming cursor.

    +
  • user: string

    Name of the user that started the query.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.QueryOptimizerRule.html b/9.0.0-preview.1/types/database.QueryOptimizerRule.html new file mode 100644 index 000000000..493b79e9f --- /dev/null +++ b/9.0.0-preview.1/types/database.QueryOptimizerRule.html @@ -0,0 +1,2 @@ +QueryOptimizerRule | arangojs - v9.0.0-preview.1

Type alias QueryOptimizerRule

QueryOptimizerRule: {
    flags: {
        canBeDisabled: boolean;
        canCreateAdditionalPlans: boolean;
        clusterOnly: boolean;
        disabledByDefault: boolean;
        enterpriseOnly: boolean;
        hidden: boolean;
    };
    name: string;
}

Optimizer rule for AQL queries.

+

Type declaration

  • flags: {
        canBeDisabled: boolean;
        canCreateAdditionalPlans: boolean;
        clusterOnly: boolean;
        disabledByDefault: boolean;
        enterpriseOnly: boolean;
        hidden: boolean;
    }
    • canBeDisabled: boolean
    • canCreateAdditionalPlans: boolean
    • clusterOnly: boolean
    • disabledByDefault: boolean
    • enterpriseOnly: boolean
    • hidden: boolean
  • name: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.QueryOptions.html b/9.0.0-preview.1/types/database.QueryOptions.html new file mode 100644 index 000000000..428f760ee --- /dev/null +++ b/9.0.0-preview.1/types/database.QueryOptions.html @@ -0,0 +1,80 @@ +QueryOptions | arangojs - v9.0.0-preview.1

Type alias QueryOptions

QueryOptions: {
    allowDirtyRead?: boolean;
    allowRetry?: boolean;
    batchSize?: number;
    cache?: boolean;
    count?: boolean;
    failOnWarning?: boolean;
    fillBlockCache?: boolean;
    fullCount?: boolean;
    intermediateCommitCount?: number;
    intermediateCommitSize?: number;
    maxNodesPerCallstack?: number;
    maxPlans?: number;
    maxRuntime?: number;
    maxTransactionSize?: number;
    maxWarningsCount?: number;
    memoryLimit?: number;
    optimizer?: {
        rules: string[];
    };
    profile?: boolean | number;
    retryOnConflict?: number;
    satelliteSyncWait?: number;
    skipInaccessibleCollections?: boolean;
    stream?: boolean;
    timeout?: number;
    ttl?: number;
}

Options for executing a query.

+

See Database#query.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the query will be executed with support for dirty reads +enabled, permitting ArangoDB to return a potentially dirty or stale result +and arangojs will load balance the request without distinguishing between +leaders and followers.

    +

    Note that dirty reads are only supported for read-only queries, not data +modification queries (e.g. using INSERT, UPDATE, REPLACE or +REMOVE) and only when using ArangoDB 3.4 or later.

    +

    Default: false

    +
  • Optional allowRetry?: boolean

    If set to true, cursor results will be stored by ArangoDB in such a way +that batch reads can be retried in the case of a communication error.

    +

    Default: false

    +
  • Optional batchSize?: number

    Number of result values to be transferred by the server in each +network roundtrip (or "batch").

    +

    Must be greater than zero.

    +
  • Optional cache?: boolean

    If set to false, the AQL query results cache lookup will be skipped for +this query.

    +

    Default: true

    +
  • Optional count?: boolean

    Unless set to false, the number of result values in the result set will +be returned in the count attribute. This may be disabled by default in +a future version of ArangoDB if calculating this value has a performance +impact for some queries.

    +

    Default: true.

    +
  • Optional failOnWarning?: boolean

    If set to true, the query will throw an exception and abort if it would + otherwise produce a warning.

    +
  • Optional fillBlockCache?: boolean

    If set to false, the query data will not be stored in the RocksDB block +cache. This can be used to avoid thrashing he block cache when reading a +lot of data.

    +
  • Optional fullCount?: boolean

    If set to true and the query has a LIMIT clause, the total number of +values matched before the last top-level LIMIT in the query was applied +will be returned in the extra.stats.fullCount attribute.

    +
  • Optional intermediateCommitCount?: number

    (RocksDB only.) Maximum number of operations after which an intermediate +commit is automatically performed.

    +
  • Optional intermediateCommitSize?: number

    (RocksDB only.) Maximum total size of operations in bytes after which an +intermediate commit is automatically performed.

    +
  • Optional maxNodesPerCallstack?: number

    Controls after how many execution nodes in a query a stack split should be +performed.

    +

    Default: 250 (200 on macOS)

    +
  • Optional maxPlans?: number

    Limits the maximum number of plans that will be created by the AQL query +optimizer.

    +
  • Optional maxRuntime?: number

    Maximum allowed execution time before the query will be killed in seconds.

    +

    If set to 0, the query will be allowed to run indefinitely.

    +

    Default: 0

    +
  • Optional maxTransactionSize?: number

    (RocksDB only.) Maximum size of transactions in bytes.

    +
  • Optional maxWarningsCount?: number

    Limits the maximum number of warnings a query will return.

    +
  • Optional memoryLimit?: number

    Maximum memory size in bytes that the query is allowed to use. +Exceeding this value will result in the query failing with an error.

    +

    If set to 0, the memory limit is disabled.

    +

    Default: 0

    +
  • Optional optimizer?: {
        rules: string[];
    }

    An object with a rules property specifying a list of optimizer rules to +be included or excluded by the optimizer for this query. Prefix a rule +name with + to include it, or - to exclude it. The name all acts as +an alias matching all optimizer rules.

    +
    • rules: string[]
  • Optional profile?: boolean | number

    If set to 1 or true, additional query profiling information will be +returned in the extra.profile attribute if the query is not served from +the result cache.

    +

    If set to 2, the query will return execution stats per query plan node +in the extra.stats.nodes attribute. Additionally the query plan is +returned in extra.plan.

    +
  • Optional retryOnConflict?: number

    If set to a positive number, the query will automatically be retried at +most this many times if it results in a write-write conflict.

    +

    Default: 0

    +
  • Optional satelliteSyncWait?: number

    (Enterprise Edition cluster only.) Limits the maximum time in seconds a +DBServer will wait to bring satellite collections involved in the query +into sync. Exceeding this value will result in the query being stopped.

    +

    Default: 60

    +
  • Optional skipInaccessibleCollections?: boolean

    (Enterprise Edition cluster only.) If set to true, collections +inaccessible to current user will result in an access error instead +of being treated as empty.

    +
  • Optional stream?: boolean

    If set to true, the query will be executed as a streaming query.

    +
  • Optional timeout?: number

    Maximum time in milliseconds arangojs will wait for a server response. +Exceeding this value will result in the request being cancelled.

    +

    Note: Setting a timeout for the client does not guarantee the query +will be killed by ArangoDB if it is already being executed. See the +maxRuntime option for limiting the execution time within ArangoDB.

    +
  • Optional ttl?: number

    Time-to-live for the cursor in seconds. The cursor results may be +garbage collected by ArangoDB after this much time has passed.

    +

    Default: 30

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.QueryTracking.html b/9.0.0-preview.1/types/database.QueryTracking.html new file mode 100644 index 000000000..e925230c7 --- /dev/null +++ b/9.0.0-preview.1/types/database.QueryTracking.html @@ -0,0 +1,9 @@ +QueryTracking | arangojs - v9.0.0-preview.1

Type alias QueryTracking

QueryTracking: {
    enabled: boolean;
    maxQueryStringLength: number;
    maxSlowQueries: number;
    slowQueryThreshold: number;
    trackBindVars: boolean;
    trackSlowQueries: boolean;
}

Information about query tracking.

+

Type declaration

  • enabled: boolean

    Whether query tracking is enabled.

    +
  • maxQueryStringLength: number

    Maximum query string length in bytes that is kept in the list.

    +
  • maxSlowQueries: number

    Maximum number of slow queries that is kept in the list.

    +
  • slowQueryThreshold: number

    Threshold execution time in seconds for when a query is +considered slow.

    +
  • trackBindVars: boolean

    Whether bind parameters are being tracked along with queries.

    +
  • trackSlowQueries: boolean

    Whether slow queries are being tracked.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.QueryTrackingOptions.html b/9.0.0-preview.1/types/database.QueryTrackingOptions.html new file mode 100644 index 000000000..d71bed141 --- /dev/null +++ b/9.0.0-preview.1/types/database.QueryTrackingOptions.html @@ -0,0 +1,11 @@ +QueryTrackingOptions | arangojs - v9.0.0-preview.1

Type alias QueryTrackingOptions

QueryTrackingOptions: {
    enabled?: boolean;
    maxQueryStringLength?: number;
    maxSlowQueries?: number;
    slowQueryThreshold?: number;
    trackBindVars?: boolean;
    trackSlowQueries?: boolean;
}

Options for query tracking.

+

See Database#queryTracking.

+

Type declaration

  • Optional enabled?: boolean

    If set to false, neither queries nor slow queries will be tracked.

    +
  • Optional maxQueryStringLength?: number

    Maximum query string length in bytes that will be kept in the list.

    +
  • Optional maxSlowQueries?: number

    Maximum number of slow queries to be kept in the list.

    +
  • Optional slowQueryThreshold?: number

    Threshold execution time in seconds for when a query will be +considered slow.

    +
  • Optional trackBindVars?: boolean

    If set to true, bind parameters will be tracked along with queries.

    +
  • Optional trackSlowQueries?: boolean

    If set to true and enabled is also set to true, slow queries will be +tracked if their execution time exceeds slowQueryThreshold.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.QueueTimeMetrics.html b/9.0.0-preview.1/types/database.QueueTimeMetrics.html new file mode 100644 index 000000000..f160cf461 --- /dev/null +++ b/9.0.0-preview.1/types/database.QueueTimeMetrics.html @@ -0,0 +1,9 @@ +QueueTimeMetrics | arangojs - v9.0.0-preview.1

Type alias QueueTimeMetrics

QueueTimeMetrics: {
    getAvg: (() => number);
    getLatest: (() => number | undefined);
    getValues: (() => [number, number][]);
}

An object providing methods for accessing queue time metrics of the most +recently received server responses if the server supports this feature.

+

Type declaration

  • getAvg: (() => number)

    Returns the average queue time of the most recently received responses +in seconds.

    +
      • (): number
      • Returns number

  • getLatest: (() => number | undefined)

    Returns the queue time of the most recently received response in seconds.

    +
      • (): number | undefined
      • Returns number | undefined

  • getValues: (() => [number, number][])

    Returns a list of the most recently received queue time values as tuples +of the timestamp of the response being processed in milliseconds and the +queue time in seconds.

    +
      • (): [number, number][]
      • Returns [number, number][]

\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ReplaceServiceOptions.html b/9.0.0-preview.1/types/database.ReplaceServiceOptions.html new file mode 100644 index 000000000..898268cbb --- /dev/null +++ b/9.0.0-preview.1/types/database.ReplaceServiceOptions.html @@ -0,0 +1,21 @@ +ReplaceServiceOptions | arangojs - v9.0.0-preview.1

Type alias ReplaceServiceOptions

ReplaceServiceOptions: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}

Options for replacing a service.

+

See Database#replaceService.

+

Type declaration

  • Optional configuration?: Record<string, any>

    An object mapping configuration option names to values.

    +

    See also Database#getServiceConfiguration.

    +
  • Optional dependencies?: Record<string, string>

    An object mapping dependency aliases to mount points.

    +

    See also Database#getServiceDependencies.

    +
  • Optional development?: boolean

    Whether the service should be installed in development mode.

    +

    See also Database#setServiceDevelopmentMode.

    +

    Default: false

    +
  • Optional force?: boolean

    If set to true, replacing a service that does not already exist will +fall back to installing the new service.

    +

    Default: false

    +
  • Optional legacy?: boolean

    Whether the service should be installed in legacy compatibility mode

    +

    This overrides the engines option in the service manifest (if any).

    +

    Default: false

    +
  • Optional setup?: boolean

    Whether the "setup" script should be executed.

    +

    Default: true

    +
  • Optional teardown?: boolean

    Whether the existing service's "teardown" script should be executed +prior to removing that service.

    +

    Default: true

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceConfiguration.html b/9.0.0-preview.1/types/database.ServiceConfiguration.html new file mode 100644 index 000000000..60cc95752 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceConfiguration.html @@ -0,0 +1,15 @@ +ServiceConfiguration | arangojs - v9.0.0-preview.1

Type alias ServiceConfiguration

ServiceConfiguration: {
    current: any;
    currentRaw: any;
    default?: any;
    description?: string;
    required: boolean;
    title: string;
    type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool";
}

Object describing a configuration option of a Foxx service.

+

Type declaration

  • current: any

    Processed current value of the configuration option as exposed in the +service code.

    +
  • currentRaw: any

    Current value of the configuration option as stored internally.

    +
  • Optional default?: any

    Default value of the configuration option.

    +
  • Optional description?: string

    Human-readable description of the configuration option.

    +
  • required: boolean

    Whether the configuration option must be set in order for the service +to be operational.

    +
  • title: string

    Formatted name of the configuration option.

    +
  • type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool"

    Data type of the configuration value.

    +

    Note: "int" and "bool" are historical synonyms for "integer" and +"boolean". The "password" type is synonymous with "string" but can +be used to distinguish values which should not be displayed in plain text +by software when managing the service.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceInfo.html b/9.0.0-preview.1/types/database.ServiceInfo.html new file mode 100644 index 000000000..2ea925e8f --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceInfo.html @@ -0,0 +1,13 @@ +ServiceInfo | arangojs - v9.0.0-preview.1

Type alias ServiceInfo

ServiceInfo: {
    checksum: string;
    development: boolean;
    legacy: boolean;
    manifest: FoxxManifest;
    mount: string;
    name?: string;
    options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    };
    path: string;
    version?: string;
}

Object describing a Foxx service in detail.

+

Type declaration

  • checksum: string

    Internal checksum of the service's initial source bundle.

    +
  • development: boolean

    Whether development mode is enabled for this service.

    +
  • legacy: boolean

    Whether the service is running in legacy compatibility mode.

    +
  • manifest: FoxxManifest

    Content of the service manifest of this service.

    +
  • mount: string

    Service mount point, relative to the database.

    +
  • Optional name?: string

    Name defined in the service manifest.

    +
  • options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    }

    Options for this service.

    +
    • configuration: Record<string, any>

      Configuration values set for this service.

      +
    • dependencies: Record<string, string>

      Service dependency configuration of this service.

      +
  • path: string

    File system path of the service.

    +
  • Optional version?: string

    Version defined in the service manifest.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceSummary.html b/9.0.0-preview.1/types/database.ServiceSummary.html new file mode 100644 index 000000000..d61089808 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceSummary.html @@ -0,0 +1,9 @@ +ServiceSummary | arangojs - v9.0.0-preview.1

Type alias ServiceSummary

ServiceSummary: {
    development: boolean;
    legacy: boolean;
    mount: string;
    name?: string;
    provides: Record<string, string>;
    version?: string;
}

Object briefly describing a Foxx service.

+

Type declaration

  • development: boolean

    Whether development mode is enabled for this service.

    +
  • legacy: boolean

    Whether the service is running in legacy compatibility mode.

    +
  • mount: string

    Service mount point, relative to the database.

    +
  • Optional name?: string

    Name defined in the service manifest.

    +
  • provides: Record<string, string>

    Service dependencies the service expects to be able to match as a mapping +from dependency names to versions the service is compatible with.

    +
  • Optional version?: string

    Version defined in the service manifest.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestDefaultReport.html b/9.0.0-preview.1/types/database.ServiceTestDefaultReport.html new file mode 100644 index 000000000..66805b958 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestDefaultReport.html @@ -0,0 +1,2 @@ +ServiceTestDefaultReport | arangojs - v9.0.0-preview.1

Type alias ServiceTestDefaultReport

ServiceTestDefaultReport: {
    failures: ServiceTestDefaultTest[];
    passes: ServiceTestDefaultTest[];
    pending: ServiceTestDefaultTest[];
    stats: ServiceTestStats;
    tests: ServiceTestDefaultTest[];
}

Test results for a Foxx service's tests using the default reporter.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestDefaultTest.html b/9.0.0-preview.1/types/database.ServiceTestDefaultTest.html new file mode 100644 index 000000000..74c83b758 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestDefaultTest.html @@ -0,0 +1,2 @@ +ServiceTestDefaultTest | arangojs - v9.0.0-preview.1

Type alias ServiceTestDefaultTest

ServiceTestDefaultTest: {
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}

Test results for a single test case using the default reporter.

+

Type declaration

  • duration: number
  • Optional err?: string
  • fullTitle: string
  • title: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestStats.html b/9.0.0-preview.1/types/database.ServiceTestStats.html new file mode 100644 index 000000000..b9b64ddc5 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestStats.html @@ -0,0 +1,7 @@ +ServiceTestStats | arangojs - v9.0.0-preview.1

Type alias ServiceTestStats

ServiceTestStats: {
    duration: number;
    failures: number;
    passes: number;
    pending: number;
    tests: number;
}

Test stats for a Foxx service's tests.

+

Type declaration

  • duration: number

    Total test duration in milliseconds.

    +
  • failures: number

    Number of tests that failed.

    +
  • passes: number

    Number of tests that ran successfully.

    +
  • pending: number

    Number of tests skipped or not executed.

    +
  • tests: number

    Total number of tests found.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestStreamReport.html b/9.0.0-preview.1/types/database.ServiceTestStreamReport.html new file mode 100644 index 000000000..9436a3a5c --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestStreamReport.html @@ -0,0 +1,2 @@ +ServiceTestStreamReport | arangojs - v9.0.0-preview.1

Type alias ServiceTestStreamReport

ServiceTestStreamReport: (["start", {
    total: number;
}] | ["pass", ServiceTestStreamTest] | ["fail", ServiceTestStreamTest] | ["end", ServiceTestStats])[]

Test results for a Foxx service's tests using the stream reporter.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestStreamTest.html b/9.0.0-preview.1/types/database.ServiceTestStreamTest.html new file mode 100644 index 000000000..eae7ccbdb --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestStreamTest.html @@ -0,0 +1,2 @@ +ServiceTestStreamTest | arangojs - v9.0.0-preview.1

Type alias ServiceTestStreamTest

ServiceTestStreamTest: {
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}

Test results for a single test case using the stream reporter.

+

Type declaration

  • duration: number
  • Optional err?: string
  • fullTitle: string
  • title: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestSuite.html b/9.0.0-preview.1/types/database.ServiceTestSuite.html new file mode 100644 index 000000000..3601120b1 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestSuite.html @@ -0,0 +1,2 @@ +ServiceTestSuite | arangojs - v9.0.0-preview.1

Type alias ServiceTestSuite

ServiceTestSuite: {
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
    title: string;
}

Test results for a single test suite using the suite reporter.

+

Type declaration

\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestSuiteReport.html b/9.0.0-preview.1/types/database.ServiceTestSuiteReport.html new file mode 100644 index 000000000..b4bb763e7 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestSuiteReport.html @@ -0,0 +1,2 @@ +ServiceTestSuiteReport | arangojs - v9.0.0-preview.1

Type alias ServiceTestSuiteReport

ServiceTestSuiteReport: {
    stats: ServiceTestStats;
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
}

Test results for a Foxx service's tests using the suite reporter.

+

Type declaration

\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestSuiteTest.html b/9.0.0-preview.1/types/database.ServiceTestSuiteTest.html new file mode 100644 index 000000000..550e7a468 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestSuiteTest.html @@ -0,0 +1,2 @@ +ServiceTestSuiteTest | arangojs - v9.0.0-preview.1

Type alias ServiceTestSuiteTest

ServiceTestSuiteTest: {
    duration: number;
    err?: any;
    result: "pending" | "pass" | "fail";
    title: string;
}

Test results for a single test case using the suite reporter.

+

Type declaration

  • duration: number
  • Optional err?: any
  • result: "pending" | "pass" | "fail"
  • title: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestTapReport.html b/9.0.0-preview.1/types/database.ServiceTestTapReport.html new file mode 100644 index 000000000..3d55264fb --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestTapReport.html @@ -0,0 +1,2 @@ +ServiceTestTapReport | arangojs - v9.0.0-preview.1

Type alias ServiceTestTapReport

ServiceTestTapReport: string[]

Test results for a Foxx service's tests in TAP format.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestXunitReport.html b/9.0.0-preview.1/types/database.ServiceTestXunitReport.html new file mode 100644 index 000000000..ca860b4bc --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestXunitReport.html @@ -0,0 +1,3 @@ +ServiceTestXunitReport | arangojs - v9.0.0-preview.1

Type alias ServiceTestXunitReport

ServiceTestXunitReport: ["testsuite", {
    errors: number;
    failures: number;
    skip: number;
    tests: number;
    time: number;
    timestamp: number;
}, ...ServiceTestXunitTest[]]

Test results for a Foxx service's tests in XUnit format using the JSONML +representation.

+

Type declaration

  • errors: number
  • failures: number
  • skip: number
  • tests: number
  • time: number
  • timestamp: number
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.ServiceTestXunitTest.html b/9.0.0-preview.1/types/database.ServiceTestXunitTest.html new file mode 100644 index 000000000..863553c98 --- /dev/null +++ b/9.0.0-preview.1/types/database.ServiceTestXunitTest.html @@ -0,0 +1,3 @@ +ServiceTestXunitTest | arangojs - v9.0.0-preview.1

Type alias ServiceTestXunitTest

ServiceTestXunitTest: ["testcase", {
    classname: string;
    name: string;
    time: number;
}] | ["testcase", {
    classname: string;
    name: string;
    time: number;
}, ["failure", {
    message: string;
    type: string;
}, string]]

Test results for a single test case in XUnit format using the JSONML +representation.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.SingleExplainResult.html b/9.0.0-preview.1/types/database.SingleExplainResult.html new file mode 100644 index 000000000..7a08a246f --- /dev/null +++ b/9.0.0-preview.1/types/database.SingleExplainResult.html @@ -0,0 +1,6 @@ +SingleExplainResult | arangojs - v9.0.0-preview.1

Type alias SingleExplainResult

SingleExplainResult: {
    cacheable: boolean;
    plan: ExplainPlan;
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}

Result of explaining a query with a single plan.

+

Type declaration

  • cacheable: boolean

    Whether it would be possible to cache the query.

    +
  • plan: ExplainPlan

    Query plan.

    +
  • stats: ExplainStats

    Optimizer statistics for the explained query.

    +
  • warnings: {
        code: number;
        message: string;
    }[]

    Warnings encountered while planning the query execution.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.SingleServiceDependency.html b/9.0.0-preview.1/types/database.SingleServiceDependency.html new file mode 100644 index 000000000..6aeafaeaf --- /dev/null +++ b/9.0.0-preview.1/types/database.SingleServiceDependency.html @@ -0,0 +1,10 @@ +SingleServiceDependency | arangojs - v9.0.0-preview.1

Type alias SingleServiceDependency

SingleServiceDependency: {
    current?: string;
    description?: string;
    multiple: false;
    name: string;
    required: boolean;
    title: string;
    version: string;
}

Object describing a single-service dependency defined by a Foxx service.

+

Type declaration

  • Optional current?: string

    Current mount point the dependency is resolved to.

    +
  • Optional description?: string

    Human-readable description of the dependency.

    +
  • multiple: false

    Whether this is a multi-service dependency.

    +
  • name: string

    Name of the service the dependency expects to match.

    +
  • required: boolean

    Whether the dependency must be matched in order for the service +to be operational.

    +
  • title: string

    Formatted name of the dependency.

    +
  • version: string

    Version of the service the dependency expects to match.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.SwaggerJson.html b/9.0.0-preview.1/types/database.SwaggerJson.html new file mode 100644 index 000000000..74cfaec80 --- /dev/null +++ b/9.0.0-preview.1/types/database.SwaggerJson.html @@ -0,0 +1,2 @@ +SwaggerJson | arangojs - v9.0.0-preview.1

Type alias SwaggerJson

SwaggerJson: {
    info: {
        description: string;
        license: string;
        title: string;
        version: string;
    };
    path: {
        [key: string]: any;
    };
    [key: string]: any;
}

OpenAPI 2.0 description of a Foxx service.

+

Type declaration

  • [key: string]: any
  • info: {
        description: string;
        license: string;
        title: string;
        version: string;
    }
    • description: string
    • license: string
    • title: string
    • version: string
  • path: {
        [key: string]: any;
    }
    • [key: string]: any
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.TransactionCollections.html b/9.0.0-preview.1/types/database.TransactionCollections.html new file mode 100644 index 000000000..8b48eac7d --- /dev/null +++ b/9.0.0-preview.1/types/database.TransactionCollections.html @@ -0,0 +1,9 @@ +TransactionCollections | arangojs - v9.0.0-preview.1

Type alias TransactionCollections

TransactionCollections: {
    exclusive?: (string | ArangoCollection)[] | string | ArangoCollection;
    read?: (string | ArangoCollection)[] | string | ArangoCollection;
    write?: (string | ArangoCollection)[] | string | ArangoCollection;
}

Collections involved in a transaction.

+

Type declaration

  • Optional exclusive?: (string | ArangoCollection)[] | string | ArangoCollection

    An array of collections or a single collection that will be read from or +written to during the transaction with no other writes being able to run +in parallel.

    +
  • Optional read?: (string | ArangoCollection)[] | string | ArangoCollection

    An array of collections or a single collection that will be read from +during the transaction.

    +
  • Optional write?: (string | ArangoCollection)[] | string | ArangoCollection

    An array of collections or a single collection that will be read from or +written to during the transaction.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.TransactionDetails.html b/9.0.0-preview.1/types/database.TransactionDetails.html new file mode 100644 index 000000000..6c0428883 --- /dev/null +++ b/9.0.0-preview.1/types/database.TransactionDetails.html @@ -0,0 +1,5 @@ +TransactionDetails | arangojs - v9.0.0-preview.1

Type alias TransactionDetails

TransactionDetails: {
    id: string;
    state: "running" | "committed" | "aborted";
}

Details for a transaction.

+

See also transaction.TransactionStatus.

+

Type declaration

  • id: string

    Unique identifier of the transaction.

    +
  • state: "running" | "committed" | "aborted"

    Status (or "state") of the transaction.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.TransactionOptions.html b/9.0.0-preview.1/types/database.TransactionOptions.html new file mode 100644 index 000000000..3681ff8f0 --- /dev/null +++ b/9.0.0-preview.1/types/database.TransactionOptions.html @@ -0,0 +1,14 @@ +TransactionOptions | arangojs - v9.0.0-preview.1

Type alias TransactionOptions

TransactionOptions: {
    allowDirtyRead?: boolean;
    allowImplicit?: boolean;
    lockTimeout?: number;
    maxTransactionSize?: number;
    waitForSync?: boolean;
}

Options for how the transaction should be performed.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
  • Optional allowImplicit?: boolean

    Whether the transaction may read from collections not specified for this +transaction. If set to false, accessing any collections not specified +will result in the transaction being aborted to avoid potential deadlocks.

    +

    Default: true.

    +
  • Optional lockTimeout?: number

    Determines how long the database will wait while attempting to gain locks +on collections used by the transaction before timing out.

    +
  • Optional maxTransactionSize?: number

    (RocksDB only.) Determines the transaction size limit in bytes.

    +
  • Optional waitForSync?: boolean

    Determines whether to force the transaction to write all data to disk +before returning.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.UninstallServiceOptions.html b/9.0.0-preview.1/types/database.UninstallServiceOptions.html new file mode 100644 index 000000000..6a8e754a1 --- /dev/null +++ b/9.0.0-preview.1/types/database.UninstallServiceOptions.html @@ -0,0 +1,9 @@ +UninstallServiceOptions | arangojs - v9.0.0-preview.1

Type alias UninstallServiceOptions

UninstallServiceOptions: {
    force?: boolean;
    teardown?: boolean;
}

Options for uninstalling a service.

+

See Database#uninstallService.

+

Type declaration

  • Optional force?: boolean

    If set to true, uninstalling a service that does not already exist +will be considered successful.

    +

    Default: false

    +
  • Optional teardown?: boolean

    Whether the service's "teardown" script should be executed +prior to removing that service.

    +

    Default: true

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.UpgradeServiceOptions.html b/9.0.0-preview.1/types/database.UpgradeServiceOptions.html new file mode 100644 index 000000000..4fa308d7d --- /dev/null +++ b/9.0.0-preview.1/types/database.UpgradeServiceOptions.html @@ -0,0 +1,21 @@ +UpgradeServiceOptions | arangojs - v9.0.0-preview.1

Type alias UpgradeServiceOptions

UpgradeServiceOptions: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}

Options for upgrading a service.

+

See Database#upgradeService.

+

Type declaration

  • Optional configuration?: Record<string, any>

    An object mapping configuration option names to values.

    +

    See also Database#getServiceConfiguration.

    +
  • Optional dependencies?: Record<string, string>

    An object mapping dependency aliases to mount points.

    +

    See also Database#getServiceDependencies.

    +
  • Optional development?: boolean

    Whether the service should be installed in development mode.

    +

    See also Database#setServiceDevelopmentMode.

    +

    Default: false

    +
  • Optional force?: boolean

    Unless set to true, upgrading a service that does not already exist will +fall back to installing the new service.

    +

    Default: false

    +
  • Optional legacy?: boolean

    Whether the service should be installed in legacy compatibility mode

    +

    This overrides the engines option in the service manifest (if any).

    +

    Default: false

    +
  • Optional setup?: boolean

    Whether the "setup" script should be executed.

    +

    Default: true

    +
  • Optional teardown?: boolean

    Whether the existing service's "teardown" script should be executed +prior to upgrading that service.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.UserAccessLevelOptions.html b/9.0.0-preview.1/types/database.UserAccessLevelOptions.html new file mode 100644 index 000000000..c29c266d9 --- /dev/null +++ b/9.0.0-preview.1/types/database.UserAccessLevelOptions.html @@ -0,0 +1,7 @@ +UserAccessLevelOptions | arangojs - v9.0.0-preview.1

Type alias UserAccessLevelOptions

UserAccessLevelOptions: {
    collection?: ArangoCollection | string;
    database?: Database | string;
}

Options for accessing or manipulating access levels.

+

Type declaration

  • Optional collection?: ArangoCollection | string

    The collection to access or manipulate the access level of.

    +
  • Optional database?: Database | string

    The database to access or manipulate the access level of.

    +

    If collection is an ArangoCollection, this option defaults to the +database the collection is contained in. Otherwise this option defaults to +the current database.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.UserOptions.html b/9.0.0-preview.1/types/database.UserOptions.html new file mode 100644 index 000000000..c2720bede --- /dev/null +++ b/9.0.0-preview.1/types/database.UserOptions.html @@ -0,0 +1,7 @@ +UserOptions | arangojs - v9.0.0-preview.1

Type alias UserOptions

UserOptions: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
}

Options for modifying an ArangoDB user.

+

Type declaration

  • Optional active?: boolean

    Whether the ArangoDB user account is enabled and can authenticate.

    +

    Default: true

    +
  • Optional extra?: Record<string, any>

    Additional information to store about this user.

    +

    Default: {}

    +
  • passwd: string

    Password the ArangoDB user will use for authentication.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/database.VersionInfo.html b/9.0.0-preview.1/types/database.VersionInfo.html new file mode 100644 index 000000000..60dff7873 --- /dev/null +++ b/9.0.0-preview.1/types/database.VersionInfo.html @@ -0,0 +1,6 @@ +VersionInfo | arangojs - v9.0.0-preview.1

Type alias VersionInfo

VersionInfo: {
    details?: {
        [key: string]: string;
    };
    license: "community" | "enterprise";
    server: string;
    version: string;
}

Result of retrieving database version information.

+

Type declaration

  • Optional details?: {
        [key: string]: string;
    }

    Additional information about the ArangoDB server.

    +
    • [key: string]: string
  • license: "community" | "enterprise"

    ArangoDB license type or "edition".

    +
  • server: string

    Value identifying the server type, i.e. "arango".

    +
  • version: string

    ArangoDB server version.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.Document.html b/9.0.0-preview.1/types/documents.Document.html new file mode 100644 index 000000000..897f5edd1 --- /dev/null +++ b/9.0.0-preview.1/types/documents.Document.html @@ -0,0 +1,2 @@ +Document | arangojs - v9.0.0-preview.1

Type alias Document<T>

Document<T>: T & DocumentMetadata & Partial<EdgeMetadata>

Type representing a document stored in a collection.

+

Type Parameters

  • T extends Record<string, any> = any
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.DocumentData.html b/9.0.0-preview.1/types/documents.DocumentData.html new file mode 100644 index 000000000..0c03ad295 --- /dev/null +++ b/9.0.0-preview.1/types/documents.DocumentData.html @@ -0,0 +1,2 @@ +DocumentData | arangojs - v9.0.0-preview.1

Type alias DocumentData<T>

DocumentData<T>: T & Partial<DocumentMetadata> & Partial<EdgeMetadata>

Type representing an object that can be stored in a collection.

+

Type Parameters

  • T extends Record<string, any> = any
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.DocumentMetadata.html b/9.0.0-preview.1/types/documents.DocumentMetadata.html new file mode 100644 index 000000000..d25b5661e --- /dev/null +++ b/9.0.0-preview.1/types/documents.DocumentMetadata.html @@ -0,0 +1,7 @@ +DocumentMetadata | arangojs - v9.0.0-preview.1

Type alias DocumentMetadata

DocumentMetadata: {
    _id: string;
    _key: string;
    _rev: string;
}

Common ArangoDB metadata properties of a document.

+

Type declaration

  • _id: string

    Unique ID of the document, which is composed of the collection name +and the document _key.

    +
  • _key: string

    Key of the document, which uniquely identifies the document within its +collection.

    +
  • _rev: string

    Revision of the document data.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.DocumentSelector.html b/9.0.0-preview.1/types/documents.DocumentSelector.html new file mode 100644 index 000000000..7a6d4d59d --- /dev/null +++ b/9.0.0-preview.1/types/documents.DocumentSelector.html @@ -0,0 +1,5 @@ +DocumentSelector | arangojs - v9.0.0-preview.1

Type alias DocumentSelector

DocumentSelector: ObjectWithId | ObjectWithKey | string

A value that can be used to identify a document within a collection in +arangojs methods, i.e. a partial ArangoDB document or the value of a +document's _key or _id.

+

See documents.DocumentMetadata.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.Edge.html b/9.0.0-preview.1/types/documents.Edge.html new file mode 100644 index 000000000..aff9908dc --- /dev/null +++ b/9.0.0-preview.1/types/documents.Edge.html @@ -0,0 +1,2 @@ +Edge | arangojs - v9.0.0-preview.1

Type alias Edge<T>

Type representing an edge document stored in an edge collection.

+

Type Parameters

  • T extends Record<string, any> = any
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.EdgeData.html b/9.0.0-preview.1/types/documents.EdgeData.html new file mode 100644 index 000000000..fd14b47e4 --- /dev/null +++ b/9.0.0-preview.1/types/documents.EdgeData.html @@ -0,0 +1,2 @@ +EdgeData | arangojs - v9.0.0-preview.1

Type alias EdgeData<T>

EdgeData<T>: T & Partial<DocumentMetadata> & EdgeMetadata

Type representing an object that can be stored in an edge collection.

+

Type Parameters

  • T extends Record<string, any> = any
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.EdgeMetadata.html b/9.0.0-preview.1/types/documents.EdgeMetadata.html new file mode 100644 index 000000000..60925263b --- /dev/null +++ b/9.0.0-preview.1/types/documents.EdgeMetadata.html @@ -0,0 +1,4 @@ +EdgeMetadata | arangojs - v9.0.0-preview.1

Type alias EdgeMetadata

EdgeMetadata: {
    _from: string;
    _to: string;
}

ArangoDB metadata defining the relations of an edge document.

+

Type declaration

  • _from: string

    Unique ID of the document that acts as the edge's start vertex.

    +
  • _to: string

    Unique ID of the document that acts as the edge's end vertex.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.ObjectWithId.html b/9.0.0-preview.1/types/documents.ObjectWithId.html new file mode 100644 index 000000000..361fd7ffe --- /dev/null +++ b/9.0.0-preview.1/types/documents.ObjectWithId.html @@ -0,0 +1,3 @@ +ObjectWithId | arangojs - v9.0.0-preview.1

Type alias ObjectWithId

ObjectWithId: {
    _id: string;
    [key: string]: any;
}

An object with an ArangoDB document _id property.

+

See documents.DocumentMetadata.

+

Type declaration

  • [key: string]: any
  • _id: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.ObjectWithKey.html b/9.0.0-preview.1/types/documents.ObjectWithKey.html new file mode 100644 index 000000000..f8b31daac --- /dev/null +++ b/9.0.0-preview.1/types/documents.ObjectWithKey.html @@ -0,0 +1,3 @@ +ObjectWithKey | arangojs - v9.0.0-preview.1

Type alias ObjectWithKey

ObjectWithKey: {
    _key: string;
    [key: string]: any;
}

An object with an ArangoDB document _key property.

+

See documents.DocumentMetadata.

+

Type declaration

  • [key: string]: any
  • _key: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/documents.Patch.html b/9.0.0-preview.1/types/documents.Patch.html new file mode 100644 index 000000000..2c52e9d16 --- /dev/null +++ b/9.0.0-preview.1/types/documents.Patch.html @@ -0,0 +1,5 @@ +Patch | arangojs - v9.0.0-preview.1

Type alias Patch<T>

Patch<T>: {
    [K in keyof T]?: T[K] | Patch<T[K]>
}

Type representing patch data for a given object type to represent a payload +ArangoDB can apply in a document PATCH request (i.e. a partial update).

+

This differs from Partial in that it also applies itself to any nested +objects recursively.

+

Type Parameters

  • T = Record<string, any>
\ No newline at end of file diff --git a/9.0.0-preview.1/types/foxx_manifest.Configuration.html b/9.0.0-preview.1/types/foxx_manifest.Configuration.html new file mode 100644 index 000000000..4a9f3ff0d --- /dev/null +++ b/9.0.0-preview.1/types/foxx_manifest.Configuration.html @@ -0,0 +1,6 @@ +Configuration | arangojs - v9.0.0-preview.1

Type alias Configuration

Configuration: {
    default?: any;
    description?: string;
    required?: boolean;
    type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool";
}

A configuration option.

+

Type declaration

  • Optional default?: any

    The default value for this option in plain JSON. Can be omitted to provide no default value.

    +
  • Optional description?: string

    A human-readable description of the option.

    +
  • Optional required?: boolean

    Whether the service can not function without this option. Defaults to true unless a default value is provided.

    +
  • type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool"

    The type of value expected for this option.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/foxx_manifest.Dependency.html b/9.0.0-preview.1/types/foxx_manifest.Dependency.html new file mode 100644 index 000000000..f25a75ec9 --- /dev/null +++ b/9.0.0-preview.1/types/foxx_manifest.Dependency.html @@ -0,0 +1,7 @@ +Dependency | arangojs - v9.0.0-preview.1

Type alias Dependency

Dependency: {
    description?: string;
    multiple?: boolean;
    name?: string;
    required?: boolean;
    version?: string;
}

A service dependency.

+

Type declaration

  • Optional description?: string

    A description of how the API is used or why it is needed.

    +
  • Optional multiple?: boolean

    Whether the dependency can be specified more than once.

    +
  • Optional name?: string

    Name of the API the service expects.

    +
  • Optional required?: boolean

    Whether the service can not function without this dependency.

    +
  • Optional version?: string

    The semantic version ranges of the API the service expects.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/foxx_manifest.File.html b/9.0.0-preview.1/types/foxx_manifest.File.html new file mode 100644 index 000000000..c4607aeed --- /dev/null +++ b/9.0.0-preview.1/types/foxx_manifest.File.html @@ -0,0 +1,5 @@ +File | arangojs - v9.0.0-preview.1
File: {
    gzip?: boolean;
    path: string;
    type?: string;
}

A service file asset.

+

Type declaration

  • Optional gzip?: boolean

    If set to true the file will be served with gzip-encoding if supported by the client. This can be useful when serving text files like client-side JavaScript, CSS or HTML.

    +
  • path: string

    Relative path of the file or folder within the service.

    +
  • Optional type?: string

    The MIME content type of the file. Defaults to an intelligent guess based on the filename's extension.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/foxx_manifest.FoxxManifest.html b/9.0.0-preview.1/types/foxx_manifest.FoxxManifest.html new file mode 100644 index 000000000..ba8421aaf --- /dev/null +++ b/9.0.0-preview.1/types/foxx_manifest.FoxxManifest.html @@ -0,0 +1,20 @@ +FoxxManifest | arangojs - v9.0.0-preview.1

Type alias FoxxManifest

FoxxManifest: {
    author?: string;
    configuration?: Record<string, Configuration>;
    contributors?: string[];
    defaultDocument?: string;
    dependencies?: Record<string, string | Dependency>;
    description?: string;
    engines?: Record<string, string> & {
        arangodb?: string;
    };
    files?: Record<string, string | File>;
    keywords?: string[];
    lib?: string;
    license?: string;
    main?: string;
    name?: string;
    provides?: Record<string, string>;
    scripts?: Record<string, string>;
    tests?: string | string[];
    thumbnail?: string;
    version?: string;
}

Schema for ArangoDB Foxx service manifests.

+

Type declaration

  • Optional author?: string

    The full name of the author of the service (i.e. you). This will be shown in the web interface.

    +
  • Optional configuration?: Record<string, Configuration>

    An object defining the configuration options this service requires.

    +
  • Optional contributors?: string[]

    A list of names of people that have contributed to the development of the service in some way. This will be shown in the web interface.

    +
  • Optional defaultDocument?: string

    If specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html".

    +
  • Optional dependencies?: Record<string, string | Dependency>

    The dependencies this service uses, i.e. which APIs its dependencies need to be compatible with.

    +
  • Optional description?: string

    A human-readable description of the service. This will be shown in the web interface.

    +
  • Optional engines?: Record<string, string> & {
        arangodb?: string;
    }

    An object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with.

    +
  • Optional files?: Record<string, string | File>

    An object defining file assets served by this service.

    +
  • Optional keywords?: string[]

    A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services.

    +
  • Optional lib?: string

    The relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest.

    +
  • Optional license?: string

    A string identifying the license under which the service is published, ideally in the form of an SPDX license identifier. This will be shown in the web interface.

    +
  • Optional main?: string

    The relative path to the main entry point of this service (relative to lib), e.g. "index.js".

    +
  • Optional name?: string

    The name of the Foxx service. This will be shown in the web interface.

    +
  • Optional provides?: Record<string, string>

    The dependencies this provides, i.e. which APIs it claims to be compatible with.

    +
  • Optional scripts?: Record<string, string>

    An object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services.

    +
  • Optional tests?: string | string[]

    A path/pattern or list of paths/patterns of JavaScript tests provided for this service.

    +
  • Optional thumbnail?: string

    The filename of a thumbnail that will be used alongside the service in the web interface. This should be a JPEG or PNG image that looks good at sizes 50x50 and 160x160.

    +
  • Optional version?: string

    The version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.AddEdgeDefinitionOptions.html b/9.0.0-preview.1/types/graph.AddEdgeDefinitionOptions.html new file mode 100644 index 000000000..37ae2905b --- /dev/null +++ b/9.0.0-preview.1/types/graph.AddEdgeDefinitionOptions.html @@ -0,0 +1,3 @@ +AddEdgeDefinitionOptions | arangojs - v9.0.0-preview.1

Type alias AddEdgeDefinitionOptions

AddEdgeDefinitionOptions: {
    satellites?: (string | ArangoCollection)[];
}

Type declaration

  • Optional satellites?: (string | ArangoCollection)[]

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid +SmartGraph.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.AddVertexCollectionOptions.html b/9.0.0-preview.1/types/graph.AddVertexCollectionOptions.html new file mode 100644 index 000000000..c96b531d6 --- /dev/null +++ b/9.0.0-preview.1/types/graph.AddVertexCollectionOptions.html @@ -0,0 +1,3 @@ +AddVertexCollectionOptions | arangojs - v9.0.0-preview.1

Type alias AddVertexCollectionOptions

AddVertexCollectionOptions: {
    satellites?: (string | ArangoCollection)[];
}

Type declaration

  • Optional satellites?: (string | ArangoCollection)[]

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid +SmartGraph.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.CreateGraphOptions.html b/9.0.0-preview.1/types/graph.CreateGraphOptions.html new file mode 100644 index 000000000..b8b020a6f --- /dev/null +++ b/9.0.0-preview.1/types/graph.CreateGraphOptions.html @@ -0,0 +1,25 @@ +CreateGraphOptions | arangojs - v9.0.0-preview.1

Type alias CreateGraphOptions

CreateGraphOptions: {
    isDisjoint?: boolean;
    isSmart?: boolean;
    numberOfShards?: number;
    orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection;
    replicationFactor?: number | "satellite";
    satellites?: (string | ArangoCollection)[];
    smartGraphAttribute?: string;
    waitForSync?: boolean;
    writeConcern?: number;
}

Option for creating a graph.

+

Type declaration

  • Optional isDisjoint?: boolean

    (Enterprise Edition cluster only.) If set to true, the graph will be +created as a Disjoint SmartGraph.

    +

    Default: false

    +
  • Optional isSmart?: boolean

    (Enterprise Edition cluster only.) If set to true, the graph will be +created as a SmartGraph.

    +

    Default: false

    +
  • Optional numberOfShards?: number

    (Cluster only.) Number of shards that is used for every collection +within this graph.

    +

    Has no effect when replicationFactor is set to "satellite".

    +
  • Optional orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection

    Additional vertex collections. Documents within these collections do not +have edges within this graph.

    +
  • Optional replicationFactor?: number | "satellite"

    (Cluster only.) Replication factor used when initially creating +collections for this graph.

    +

    Default: 1

    +
  • Optional satellites?: (string | ArangoCollection)[]

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid +SmartGraph.

    +
  • Optional smartGraphAttribute?: string

    (Enterprise Edition cluster only.) Attribute containing the shard key +value to use for smart sharding.

    +
  • Optional waitForSync?: boolean

    If set to true, the request will wait until all modifications have been +synchronized to disk before returning successfully.

    +

    Default: false

    +
  • Optional writeConcern?: number

    (Cluster only.) Write concern for new collections in the graph.

    +

    Has no effect when replicationFactor is set to "satellite".

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.EdgeDefinition.html b/9.0.0-preview.1/types/graph.EdgeDefinition.html new file mode 100644 index 000000000..95bef88cb --- /dev/null +++ b/9.0.0-preview.1/types/graph.EdgeDefinition.html @@ -0,0 +1,5 @@ +EdgeDefinition | arangojs - v9.0.0-preview.1

Type alias EdgeDefinition

EdgeDefinition: {
    collection: string;
    from: string[];
    to: string[];
}

Definition of a relation in a graph.Graph.

+

Type declaration

  • collection: string

    Name of the collection containing the edges.

    +
  • from: string[]

    Array of names of collections containing the start vertices.

    +
  • to: string[]

    Array of names of collections containing the end vertices.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.EdgeDefinitionOptions.html b/9.0.0-preview.1/types/graph.EdgeDefinitionOptions.html new file mode 100644 index 000000000..3aaa82008 --- /dev/null +++ b/9.0.0-preview.1/types/graph.EdgeDefinitionOptions.html @@ -0,0 +1,5 @@ +EdgeDefinitionOptions | arangojs - v9.0.0-preview.1

Type alias EdgeDefinitionOptions

EdgeDefinitionOptions: {
    collection: string | ArangoCollection;
    from: (string | ArangoCollection)[] | string | ArangoCollection;
    to: (string | ArangoCollection)[] | string | ArangoCollection;
}

An edge definition used to define a collection of edges in a graph.Graph.

+

Type declaration

\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.GraphCollectionInsertOptions.html b/9.0.0-preview.1/types/graph.GraphCollectionInsertOptions.html new file mode 100644 index 000000000..16614b402 --- /dev/null +++ b/9.0.0-preview.1/types/graph.GraphCollectionInsertOptions.html @@ -0,0 +1,7 @@ +GraphCollectionInsertOptions | arangojs - v9.0.0-preview.1

Type alias GraphCollectionInsertOptions

GraphCollectionInsertOptions: {
    returnNew?: boolean;
    waitForSync?: boolean;
}

Options for inserting a document into a graph collection.

+

Type declaration

  • Optional returnNew?: boolean

    If set to true, the complete new document will be returned as the new +property on the result object.

    +

    Default: false

    +
  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.GraphCollectionReadOptions.html b/9.0.0-preview.1/types/graph.GraphCollectionReadOptions.html new file mode 100644 index 000000000..d63e8b765 --- /dev/null +++ b/9.0.0-preview.1/types/graph.GraphCollectionReadOptions.html @@ -0,0 +1,12 @@ +GraphCollectionReadOptions | arangojs - v9.0.0-preview.1

Type alias GraphCollectionReadOptions

GraphCollectionReadOptions: {
    allowDirtyRead?: boolean;
    graceful?: boolean;
    rev?: string;
}

Options for retrieving a document from a graph collection.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +

    Default: false

    +
  • Optional graceful?: boolean

    If set to true, null is returned instead of an exception being thrown +if the document does not exist.

    +

    Default: false

    +
  • Optional rev?: string

    If set to a document revision, the document will only be returned if its +_rev property matches this value.

    +

    See also documents.DocumentMetadata.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.GraphCollectionRemoveOptions.html b/9.0.0-preview.1/types/graph.GraphCollectionRemoveOptions.html new file mode 100644 index 000000000..e204e1f14 --- /dev/null +++ b/9.0.0-preview.1/types/graph.GraphCollectionRemoveOptions.html @@ -0,0 +1,10 @@ +GraphCollectionRemoveOptions | arangojs - v9.0.0-preview.1

Type alias GraphCollectionRemoveOptions

GraphCollectionRemoveOptions: {
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}

Options for removing a document from a graph collection.

+

Type declaration

  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old +property on the result object.

    +

    Default: false

    +
  • Optional rev?: string

    If set to a document revision, the document will only be removed if its +_rev property matches this value.

    +

    See also documents.DocumentMetadata.

    +
  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.GraphCollectionReplaceOptions.html b/9.0.0-preview.1/types/graph.GraphCollectionReplaceOptions.html new file mode 100644 index 000000000..e1821debe --- /dev/null +++ b/9.0.0-preview.1/types/graph.GraphCollectionReplaceOptions.html @@ -0,0 +1,16 @@ +GraphCollectionReplaceOptions | arangojs - v9.0.0-preview.1

Type alias GraphCollectionReplaceOptions

GraphCollectionReplaceOptions: {
    keepNull?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}

Options for replacing a document in a graph collection.

+

Type declaration

  • Optional keepNull?: boolean

    If set to false, properties with a value of null will be removed from +the new document.

    +

    Default: true

    +
  • Optional returnNew?: boolean

    If set to true, the complete new document will be returned as the new +property on the result object.

    +

    Default: false

    +
  • Optional returnOld?: boolean

    If set to true, the complete old document will be returned as the old +property on the result object.

    +

    Default: false

    +
  • Optional rev?: string

    If set to a document revision, the document will only be modified if its +_rev property matches this value.

    +

    See also documents.DocumentMetadata.

    +
  • Optional waitForSync?: boolean

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.GraphInfo.html b/9.0.0-preview.1/types/graph.GraphInfo.html new file mode 100644 index 000000000..1158cde4a --- /dev/null +++ b/9.0.0-preview.1/types/graph.GraphInfo.html @@ -0,0 +1,19 @@ +GraphInfo | arangojs - v9.0.0-preview.1

Type alias GraphInfo

GraphInfo: {
    edgeDefinitions: EdgeDefinition[];
    isDisjoint?: boolean;
    isSatellite?: boolean;
    isSmart?: boolean;
    name: string;
    numberOfShards?: number;
    orphanCollections: string[];
    replicationFactor?: number;
    smartGraphAttribute?: string;
    writeConcern?: number;
}

General information about a graph.

+

Type declaration

  • edgeDefinitions: EdgeDefinition[]

    Definitions for the relations of the graph.

    +
  • Optional isDisjoint?: boolean

    (Enterprise Edition cluster only.) If set to true, the graph has been +created as a Disjoint SmartGraph.

    +
  • Optional isSatellite?: boolean

    (Enterprise Edition cluster only.) If set to true, the graph is a +SatelliteGraph.

    +
  • Optional isSmart?: boolean

    (Enterprise Edition cluster only.) If set to true, the graph has been +created as a SmartGraph.

    +
  • name: string

    Name of the graph.

    +
  • Optional numberOfShards?: number

    (Cluster only.) Number of shards that is used for every collection +within this graph.

    +
  • orphanCollections: string[]

    Additional vertex collections. Documents within these collections do not +have edges within this graph.

    +
  • Optional replicationFactor?: number

    (Cluster only.) Replication factor used when initially creating +collections for this graph.

    +
  • Optional smartGraphAttribute?: string

    (Enterprise Edition cluster only.) Attribute containing the shard key +value to use for smart sharding.

    +
  • Optional writeConcern?: number

    (Cluster only.) Write concern for new collections in the graph.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/graph.ReplaceEdgeDefinitionOptions.html b/9.0.0-preview.1/types/graph.ReplaceEdgeDefinitionOptions.html new file mode 100644 index 000000000..6d8118ef6 --- /dev/null +++ b/9.0.0-preview.1/types/graph.ReplaceEdgeDefinitionOptions.html @@ -0,0 +1,3 @@ +ReplaceEdgeDefinitionOptions | arangojs - v9.0.0-preview.1

Type alias ReplaceEdgeDefinitionOptions

ReplaceEdgeDefinitionOptions: {
    satellites?: string[];
}

Type declaration

  • Optional satellites?: string[]

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid +SmartGraph.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.EnsureGeoIndexOptions.html b/9.0.0-preview.1/types/indexes.EnsureGeoIndexOptions.html new file mode 100644 index 000000000..1756c7be7 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.EnsureGeoIndexOptions.html @@ -0,0 +1,31 @@ +EnsureGeoIndexOptions | arangojs - v9.0.0-preview.1

Type alias EnsureGeoIndexOptions

EnsureGeoIndexOptions: {
    fields: [string, string];
    geoJson?: false;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
} | {
    fields: [string];
    geoJson?: boolean;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
}

Options for creating a geo index.

+

Type declaration

  • fields: [string, string]

    Attribute paths for the document's latitude and longitude values.

    +
  • Optional geoJson?: false

    If set to true, fields must be an array containing a single attribute +path and the attribute value must be an array with two values, the first +of which will be interpreted as the longitude and the second of which will +be interpreted as the latitude of the document.

    +

    Default: false

    +
  • Optional inBackground?: boolean

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • Optional legacyPolygons?: boolean

    If set to true, the index will use pre-3.10 rules for parsing +GeoJSON polygons. This option is always implicitly true when using +ArangoDB 3.9 or lower.

    +
  • Optional name?: string

    A unique name for this index.

    +
  • type: "geo"

Type declaration

  • fields: [string]

    An array containing the attribute path for an array containing two values, +the first of which will be interpreted as the latitude, the second as the +longitude. If geoJson is set to true, the order is reversed to match +the GeoJSON format.

    +
  • Optional geoJson?: boolean

    If set to true, fields must be an array containing a single attribute +path and the attribute value must be an array with two values, the first +of which will be interpreted as the longitude and the second of which will +be interpreted as the latitude of the document.

    +

    Default: false

    +
  • Optional inBackground?: boolean

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • Optional legacyPolygons?: boolean

    If set to true, the index will use pre-3.10 rules for parsing +GeoJSON polygons. This option is always implicitly true when using +ArangoDB 3.9 or lower.

    +
  • Optional name?: string

    A unique name for this index.

    +
  • type: "geo"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.EnsureInvertedIndexOptions.html b/9.0.0-preview.1/types/indexes.EnsureInvertedIndexOptions.html new file mode 100644 index 000000000..5c119b155 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.EnsureInvertedIndexOptions.html @@ -0,0 +1,65 @@ +EnsureInvertedIndexOptions | arangojs - v9.0.0-preview.1

Type alias EnsureInvertedIndexOptions

EnsureInvertedIndexOptions: {
    analyzer?: string;
    cache?: boolean;
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    features?: AnalyzerFeature[];
    fields: (string | InvertedIndexFieldOptions)[];
    inBackground?: boolean;
    includeAllFields?: boolean;
    name?: string;
    optimizeTopK?: string[];
    parallelism?: number;
    primaryKeyCache?: boolean;
    primarySort?: {
        cache?: boolean;
        compression?: Compression;
        fields: InvertedIndexPrimarySortFieldOptions[];
    };
    searchField?: boolean;
    storedValues?: InvertedIndexStoredValueOptions[];
    trackListPositions?: boolean;
    type: "inverted";
    writeBufferActive?: number;
    writeBufferIdle?: number;
    writeBufferSizeMax?: number;
}

Options for creating an inverted index.

+

Type declaration

  • Optional analyzer?: string

    Name of the default Analyzer to apply to the values of indexed fields.

    +

    Default: "identity"

    +
  • Optional cache?: boolean

    (Enterprise Edition only.) If set to true, then field normalization +values will always be cached in memory.

    +

    Default: false

    +
  • Optional cleanupIntervalStep?: number

    Wait at least this many commits between removing unused files in the +ArangoSearch data directory.

    +

    Default: 2

    +
  • Optional commitIntervalMsec?: number

    Wait at least this many milliseconds between committing View data store +changes and making documents visible to queries.

    +

    Default: 1000

    +
  • Optional consolidationIntervalMsec?: number

    Wait at least this many milliseconds between applying +consolidationPolicy to consolidate View data store and possibly release +space on the filesystem.

    +

    Default: 1000

    +
  • Optional consolidationPolicy?: TierConsolidationPolicy

    The consolidation policy to apply for selecting which segments should be +merged.

    +

    Default: { type: "tier" }

    +
  • Optional features?: AnalyzerFeature[]

    List of Analyzer features to enable for the default Analyzer.

    +

    Defaults to the Analyzer's features.

    +
  • fields: (string | InvertedIndexFieldOptions)[]

    An array of attribute paths or objects specifying options for the fields.

    +
  • Optional inBackground?: boolean

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • Optional includeAllFields?: boolean

    If set to true, all document attributes are indexed, excluding any +sub-attributes configured in the fields array. The analyzer and +features properties apply to the sub-attributes. This option only +applies when using the index in a SearchAlias View.

    +

    Default: false

    +
  • Optional name?: string

    A unique name for this index.

    +
  • Optional optimizeTopK?: string[]

    An array of strings defining sort expressions to optimize.

    +
  • Optional parallelism?: number

    The number of threads to use for indexing the fields.

    +

    Default: 2

    +
  • Optional primaryKeyCache?: boolean

    (Enterprise Edition only.) If set to true, then the primary key column +will always be cached in memory.

    +

    Default: false

    +
  • Optional primarySort?: {
        cache?: boolean;
        compression?: Compression;
        fields: InvertedIndexPrimarySortFieldOptions[];
    }

    Primary sort order to optimize AQL queries using a matching sort order.

    +
    • Optional cache?: boolean

      (Enterprise Edition only.) If set to true, then primary sort columns +will always be cached in memory.

      +

      Default: false

      +
    • Optional compression?: Compression

      How the primary sort data should be compressed.

      +

      Default: "lz4"

      +
    • fields: InvertedIndexPrimarySortFieldOptions[]

      An array of fields to sort the index by.

      +
  • Optional searchField?: boolean

    If set to true array values will by default be indexed using the same +behavior as ArangoSearch Views. This option only applies when using the +index in a SearchAlias View.

    +

    Default: false

    +
  • Optional storedValues?: InvertedIndexStoredValueOptions[]

    An array of attribute paths that will be stored in the index but can not +be used for index lookups or sorting but can avoid full document lookups.

    +
  • Optional trackListPositions?: boolean

    If set to true, the position of values in array values are tracked and +need to be specified in queries. Otherwise all values in an array are +treated as equivalent. This option only applies when using the index in a +SearchAlias View.

    +

    Default: false

    +
  • type: "inverted"

    Type of this index.

    +
  • Optional writeBufferActive?: number

    Maximum number of concurrent active writers (segments) that perform a +transaction.

    +

    Default: 0 (disabled)

    +
  • Optional writeBufferIdle?: number

    Maximum number of writers (segments) cached in the pool.

    +

    Default: 64

    +
  • Optional writeBufferSizeMax?: number

    Maximum memory byte size per writer (segment) before a writer (segment) +flush is triggered.

    +

    Default: 33554432 (32 MiB)

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.EnsureMdiIndexOptions.html b/9.0.0-preview.1/types/indexes.EnsureMdiIndexOptions.html new file mode 100644 index 000000000..d3d87c027 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.EnsureMdiIndexOptions.html @@ -0,0 +1,11 @@ +EnsureMdiIndexOptions | arangojs - v9.0.0-preview.1

Type alias EnsureMdiIndexOptions

EnsureMdiIndexOptions: {
    fieldValueTypes: "double";
    fields: string[];
    inBackground?: boolean;
    name?: string;
    type: "mdi";
    unique?: boolean;
}

Options for creating a MDI index.

+

Type declaration

  • fieldValueTypes: "double"

    Data type of the dimension attributes.

    +
  • fields: string[]

    An array containing attribute paths for the dimensions.

    +
  • Optional inBackground?: boolean

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • Optional name?: string

    A unique name for this index.

    +
  • type: "mdi"

    Type of this index.

    +
  • Optional unique?: boolean

    If set to true, a unique index will be created.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.EnsurePersistentIndexOptions.html b/9.0.0-preview.1/types/indexes.EnsurePersistentIndexOptions.html new file mode 100644 index 000000000..277ae0349 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.EnsurePersistentIndexOptions.html @@ -0,0 +1,25 @@ +EnsurePersistentIndexOptions | arangojs - v9.0.0-preview.1

Type alias EnsurePersistentIndexOptions

EnsurePersistentIndexOptions: {
    cacheEnabled?: boolean;
    deduplicate?: boolean;
    estimates?: boolean;
    fields: string[];
    inBackground?: boolean;
    name?: string;
    sparse?: boolean;
    storedValues?: string[];
    type: "persistent";
    unique?: boolean;
}

Options for creating a persistent index.

+

Type declaration

  • Optional cacheEnabled?: boolean

    If set to true, an in-memory hash cache will be put in front of the +persistent index.

    +

    Default: false

    +
  • Optional deduplicate?: boolean

    If set to false, inserting duplicate index values from the same +document will lead to a unique constraint error if this is a unique index.

    +

    Default: true

    +
  • Optional estimates?: boolean

    If set to false, index selectivity estimates will be disabled for this +index.

    +

    Default: true

    +
  • fields: string[]

    An array of attribute paths.

    +
  • Optional inBackground?: boolean

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • Optional name?: string

    A unique name for this index.

    +
  • Optional sparse?: boolean

    If set to true, the index will omit documents that do not contain at +least one of the attribute paths in fields and these documents will be +ignored for uniqueness checks.

    +

    Default: false

    +
  • Optional storedValues?: string[]

    An array of attribute paths that will be stored in the index but can not +be used for index lookups or sorting but can avoid full document lookups.

    +
  • type: "persistent"

    Type of this index.

    +
  • Optional unique?: boolean

    If set to true, a unique index will be created.

    +

    Default: false

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.EnsureTtlIndexOptions.html b/9.0.0-preview.1/types/indexes.EnsureTtlIndexOptions.html new file mode 100644 index 000000000..b7a990aa2 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.EnsureTtlIndexOptions.html @@ -0,0 +1,10 @@ +EnsureTtlIndexOptions | arangojs - v9.0.0-preview.1

Type alias EnsureTtlIndexOptions

EnsureTtlIndexOptions: {
    expireAfter: number;
    fields: [string];
    inBackground?: boolean;
    name?: string;
    type: "ttl";
}

Options for creating a TTL index.

+

Type declaration

  • expireAfter: number

    Duration in seconds after the attribute value at which the document will +be considered as expired.

    +
  • fields: [string]

    An array containing exactly one attribute path.

    +
  • Optional inBackground?: boolean

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • Optional name?: string

    A unique name for this index.

    +
  • type: "ttl"

    Type of this index.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.GenericIndex.html b/9.0.0-preview.1/types/indexes.GenericIndex.html new file mode 100644 index 000000000..35bd0b1c1 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.GenericIndex.html @@ -0,0 +1,7 @@ +GenericIndex | arangojs - v9.0.0-preview.1

Type alias GenericIndex

GenericIndex: {
    id: string;
    name: string;
    sparse: boolean;
    unique: boolean;
}

Shared attributes of all index types.

+

Type declaration

  • id: string

    A unique identifier for this index.

    +
  • name: string

    A unique name for this index.

    +
  • sparse: boolean

    Whether documents not containing at least one of the attribute paths +are omitted by this index.

    +
  • unique: boolean

    Whether this index enforces uniqueness for values of its attribute paths.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.GeoIndex.html b/9.0.0-preview.1/types/indexes.GeoIndex.html new file mode 100644 index 000000000..f2c1f5d60 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.GeoIndex.html @@ -0,0 +1,2 @@ +GeoIndex | arangojs - v9.0.0-preview.1

Type alias GeoIndex

GeoIndex: GenericIndex & {
    bestIndexedLevel: number;
    fields: [string] | [string, string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
}

An object representing a geo index.

+

Type declaration

  • bestIndexedLevel: number
  • fields: [string] | [string, string]
  • geoJson: boolean
  • legacyPolygons: boolean
  • maxNumCoverCells: number
  • type: "geo"
  • worstIndexedLevel: number
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.Index.html b/9.0.0-preview.1/types/indexes.Index.html new file mode 100644 index 000000000..0cd76591e --- /dev/null +++ b/9.0.0-preview.1/types/indexes.Index.html @@ -0,0 +1,2 @@ +Index | arangojs - v9.0.0-preview.1

Type alias Index

An object representing an index.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.IndexSelector.html b/9.0.0-preview.1/types/indexes.IndexSelector.html new file mode 100644 index 000000000..180d12856 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.IndexSelector.html @@ -0,0 +1,2 @@ +IndexSelector | arangojs - v9.0.0-preview.1

Type alias IndexSelector

IndexSelector: ObjectWithId | ObjectWithName | string

Index name, id or object with a name or id property.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.InvertedIndex.html b/9.0.0-preview.1/types/indexes.InvertedIndex.html new file mode 100644 index 000000000..f8ab96b50 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.InvertedIndex.html @@ -0,0 +1,2 @@ +InvertedIndex | arangojs - v9.0.0-preview.1

Type alias InvertedIndex

InvertedIndex: GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
}

An object representing an inverted index.

+

Type declaration

  • analyzer: string
  • Optional cache?: boolean
  • cleanupIntervalStep: number
  • commitIntervalMsec: number
  • consolidationIntervalMsec: number
  • consolidationPolicy: Required<TierConsolidationPolicy>
  • features: AnalyzerFeature[]
  • fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[]
  • includeAllFields: boolean
  • optimizeTopK: string[]
  • parallelism: number
  • Optional primaryKeyCache?: boolean
  • primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    }
    • Optional cache?: boolean
    • compression: Compression
    • fields: {
          direction: Direction;
          field: string;
      }[]
  • searchField: boolean
  • storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[]
  • trackListPositions: boolean
  • type: "inverted"
  • writeBufferActive: number
  • writeBufferIdle: number
  • writeBufferSizeMax: number
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.InvertedIndexFieldOptions.html b/9.0.0-preview.1/types/indexes.InvertedIndexFieldOptions.html new file mode 100644 index 000000000..babc0db65 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.InvertedIndexFieldOptions.html @@ -0,0 +1,27 @@ +InvertedIndexFieldOptions | arangojs - v9.0.0-preview.1

Type alias InvertedIndexFieldOptions

InvertedIndexFieldOptions: {
    analyzer?: string;
    cache?: boolean;
    features?: AnalyzerFeature[];
    includeAllFields?: boolean;
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
    trackListPositions?: boolean;
}

Options for an attribute path in an inverted index.

+

Type declaration

  • Optional analyzer?: string

    Name of the Analyzer to apply to the values of this field.

    +

    Defaults to the analyzer specified on the index itself.

    +
  • Optional cache?: boolean

    (Enterprise Edition only.) If set to true, then field normalization +values will always be cached in memory.

    +

    Defaults to the value of cache specified on the index itself.

    +
  • Optional features?: AnalyzerFeature[]

    List of Analyzer features to enable for this field's Analyzer.

    +

    Defaults to the features of the Analyzer.

    +
  • Optional includeAllFields?: boolean

    If set to true, all document attributes are indexed, excluding any +sub-attributes configured in the fields array. The analyzer and +features properties apply to the sub-attributes. This option only +applies when using the index in a SearchAlias View.

    +

    Defaults to the value of includeAllFields specified on the index itself.

    +
  • name: string

    An attribute path.

    +
  • Optional nested?: (string | InvertedIndexNestedFieldOptions)[]

    (Enterprise Edition only.) Sub-objects to index to allow querying for +co-occurring values.

    +
  • Optional searchField?: boolean

    If set to true array values will be indexed using the same behavior as +ArangoSearch Views. This option only applies when using the index in a +SearchAlias View.

    +

    Defaults to the value of searchField specified on the index itself.

    +
  • Optional trackListPositions?: boolean

    If set to true, the position of values in array values are tracked and +need to be specified in queries. Otherwise all values in an array are +treated as equivalent. This option only applies when using the index in a +SearchAlias View.

    +

    Defaults to the value of trackListPositions specified on the index +itself.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.InvertedIndexNestedField.html b/9.0.0-preview.1/types/indexes.InvertedIndexNestedField.html new file mode 100644 index 000000000..4c409b97f --- /dev/null +++ b/9.0.0-preview.1/types/indexes.InvertedIndexNestedField.html @@ -0,0 +1,3 @@ +InvertedIndexNestedField | arangojs - v9.0.0-preview.1

Type alias InvertedIndexNestedField

InvertedIndexNestedField: {
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: InvertedIndexNestedField[];
    searchField?: boolean;
}

(Enterprise Edition only.) An object representing a nested field in an +inverted index.

+

Type declaration

\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.InvertedIndexNestedFieldOptions.html b/9.0.0-preview.1/types/indexes.InvertedIndexNestedFieldOptions.html new file mode 100644 index 000000000..430ff0c16 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.InvertedIndexNestedFieldOptions.html @@ -0,0 +1,13 @@ +InvertedIndexNestedFieldOptions | arangojs - v9.0.0-preview.1

Type alias InvertedIndexNestedFieldOptions

InvertedIndexNestedFieldOptions: {
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
}

(Enterprise Edition only.) Options for a nested field in an inverted index.

+

Type declaration

  • Optional analyzer?: string

    Name of the Analyzer to apply to the values of this field.

    +

    Defaults to the analyzer specified on the parent options or on the index +itself.

    +
  • Optional features?: AnalyzerFeature[]

    List of Analyzer features to enable for this field's Analyzer.

    +

    Defaults to the features of the Analyzer.

    +
  • name: string

    An attribute path.

    +
  • Optional nested?: (string | InvertedIndexNestedFieldOptions)[]

    Sub-objects to index to allow querying for co-occurring values.

    +
  • Optional searchField?: boolean

    If set to true array values will be indexed using the same behavior as +ArangoSearch Views. This option only applies when using the index in a +SearchAlias View.

    +

    Defaults to the value of searchField specified on the index itself.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.InvertedIndexPrimarySortFieldOptions.html b/9.0.0-preview.1/types/indexes.InvertedIndexPrimarySortFieldOptions.html new file mode 100644 index 000000000..d0491735e --- /dev/null +++ b/9.0.0-preview.1/types/indexes.InvertedIndexPrimarySortFieldOptions.html @@ -0,0 +1,4 @@ +InvertedIndexPrimarySortFieldOptions | arangojs - v9.0.0-preview.1

Type alias InvertedIndexPrimarySortFieldOptions

InvertedIndexPrimarySortFieldOptions: {
    direction: Direction;
    field: string;
}

Options for defining a primary sort field on an inverted index.

+

Type declaration

  • direction: Direction

    The sorting direction.

    +
  • field: string

    The attribute path to sort by.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.InvertedIndexStoredValueOptions.html b/9.0.0-preview.1/types/indexes.InvertedIndexStoredValueOptions.html new file mode 100644 index 000000000..fec070475 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.InvertedIndexStoredValueOptions.html @@ -0,0 +1,8 @@ +InvertedIndexStoredValueOptions | arangojs - v9.0.0-preview.1

Type alias InvertedIndexStoredValueOptions

InvertedIndexStoredValueOptions: {
    cache?: boolean;
    compression?: Compression;
    fields: string[];
}

Options for defining a stored value on an inverted index.

+

Type declaration

  • Optional cache?: boolean

    (Enterprise Edition only.) If set to true, then stored values will +always be cached in memory.

    +

    Default: false

    +
  • Optional compression?: Compression

    How the attribute values should be compressed.

    +

    Default: "lz4"

    +
  • fields: string[]

    The attribute paths to store.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.MdiIndex.html b/9.0.0-preview.1/types/indexes.MdiIndex.html new file mode 100644 index 000000000..301731827 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.MdiIndex.html @@ -0,0 +1,2 @@ +MdiIndex | arangojs - v9.0.0-preview.1

Type alias MdiIndex

MdiIndex: GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
}

An object representing a MDI index.

+

Type declaration

  • fieldValueTypes: "double"
  • fields: string[]
  • type: "mdi"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.ObjectWithId.html b/9.0.0-preview.1/types/indexes.ObjectWithId.html new file mode 100644 index 000000000..0e76d86d8 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.ObjectWithId.html @@ -0,0 +1 @@ +ObjectWithId | arangojs - v9.0.0-preview.1

Type alias ObjectWithId

ObjectWithId: {
    id: string;
    [key: string]: any;
}

Type declaration

  • [key: string]: any
  • id: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.ObjectWithName.html b/9.0.0-preview.1/types/indexes.ObjectWithName.html new file mode 100644 index 000000000..7b3b7d4a7 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.ObjectWithName.html @@ -0,0 +1 @@ +ObjectWithName | arangojs - v9.0.0-preview.1

Type alias ObjectWithName

ObjectWithName: {
    name: string;
    [key: string]: any;
}

Type declaration

  • [key: string]: any
  • name: string
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.PersistentIndex.html b/9.0.0-preview.1/types/indexes.PersistentIndex.html new file mode 100644 index 000000000..095b6a1c4 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.PersistentIndex.html @@ -0,0 +1,2 @@ +PersistentIndex | arangojs - v9.0.0-preview.1

Type alias PersistentIndex

PersistentIndex: GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
}

An object representing a persistent index.

+

Type declaration

  • cacheEnabled: boolean
  • deduplicate: boolean
  • estimates: boolean
  • fields: string[]
  • Optional storedValues?: string[]
  • type: "persistent"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.PrimaryIndex.html b/9.0.0-preview.1/types/indexes.PrimaryIndex.html new file mode 100644 index 000000000..4da8861dd --- /dev/null +++ b/9.0.0-preview.1/types/indexes.PrimaryIndex.html @@ -0,0 +1,2 @@ +PrimaryIndex | arangojs - v9.0.0-preview.1

Type alias PrimaryIndex

PrimaryIndex: GenericIndex & {
    fields: string[];
    selectivityEstimate: number;
    type: "primary";
}

An object representing a primary index.

+

Type declaration

  • fields: string[]
  • selectivityEstimate: number
  • type: "primary"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/indexes.TtlIndex.html b/9.0.0-preview.1/types/indexes.TtlIndex.html new file mode 100644 index 000000000..6bcad6284 --- /dev/null +++ b/9.0.0-preview.1/types/indexes.TtlIndex.html @@ -0,0 +1,2 @@ +TtlIndex | arangojs - v9.0.0-preview.1

Type alias TtlIndex

TtlIndex: GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
}

An object representing a TTL index.

+

Type declaration

  • expireAfter: number
  • fields: [string]
  • selectivityEstimate: number
  • type: "ttl"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/transaction.TransactionAbortOptions.html b/9.0.0-preview.1/types/transaction.TransactionAbortOptions.html new file mode 100644 index 000000000..ec1bd5c89 --- /dev/null +++ b/9.0.0-preview.1/types/transaction.TransactionAbortOptions.html @@ -0,0 +1,5 @@ +TransactionAbortOptions | arangojs - v9.0.0-preview.1

Type alias TransactionAbortOptions

TransactionAbortOptions: {
    allowDirtyRead?: boolean;
}

Options for how the transaction should be aborted.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/transaction.TransactionCommitOptions.html b/9.0.0-preview.1/types/transaction.TransactionCommitOptions.html new file mode 100644 index 000000000..d579d6d22 --- /dev/null +++ b/9.0.0-preview.1/types/transaction.TransactionCommitOptions.html @@ -0,0 +1,5 @@ +TransactionCommitOptions | arangojs - v9.0.0-preview.1

Type alias TransactionCommitOptions

TransactionCommitOptions: {
    allowDirtyRead?: boolean;
}

Options for how the transaction should be committed.

+

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/transaction.TransactionStatus.html b/9.0.0-preview.1/types/transaction.TransactionStatus.html new file mode 100644 index 000000000..c23646756 --- /dev/null +++ b/9.0.0-preview.1/types/transaction.TransactionStatus.html @@ -0,0 +1,5 @@ +TransactionStatus | arangojs - v9.0.0-preview.1

Type alias TransactionStatus

TransactionStatus: {
    id: string;
    status: "running" | "committed" | "aborted";
}

Status of a given transaction.

+

See also database.TransactionDetails.

+

Type declaration

  • id: string

    Unique identifier of the transaction.

    +
  • status: "running" | "committed" | "aborted"

    Status of the transaction.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ArangoSearchViewDescription.html b/9.0.0-preview.1/types/view.ArangoSearchViewDescription.html new file mode 100644 index 000000000..43a52f210 --- /dev/null +++ b/9.0.0-preview.1/types/view.ArangoSearchViewDescription.html @@ -0,0 +1 @@ +ArangoSearchViewDescription | arangojs - v9.0.0-preview.1

Type alias ArangoSearchViewDescription

ArangoSearchViewDescription: GenericViewDescription & {
    type: "arangosearch";
}

Type declaration

  • type: "arangosearch"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ArangoSearchViewLink.html b/9.0.0-preview.1/types/view.ArangoSearchViewLink.html new file mode 100644 index 000000000..3a04a92c8 --- /dev/null +++ b/9.0.0-preview.1/types/view.ArangoSearchViewLink.html @@ -0,0 +1,2 @@ +ArangoSearchViewLink | arangojs - v9.0.0-preview.1

Type alias ArangoSearchViewLink

ArangoSearchViewLink: {
    analyzers: string[];
    cache: boolean;
    fields: Record<string, ArangoSearchViewLink>;
    includeAllFields: boolean;
    nested?: Record<string, ArangoSearchViewLink>;
    storeValues: "none" | "id";
    trackListPositions: boolean;
}

A link definition for an ArangoSearch View.

+

Type declaration

  • analyzers: string[]
  • cache: boolean
  • fields: Record<string, ArangoSearchViewLink>
  • includeAllFields: boolean
  • Optional nested?: Record<string, ArangoSearchViewLink>
  • storeValues: "none" | "id"
  • trackListPositions: boolean
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ArangoSearchViewLinkOptions.html b/9.0.0-preview.1/types/view.ArangoSearchViewLinkOptions.html new file mode 100644 index 000000000..d74c93591 --- /dev/null +++ b/9.0.0-preview.1/types/view.ArangoSearchViewLinkOptions.html @@ -0,0 +1,23 @@ +ArangoSearchViewLinkOptions | arangojs - v9.0.0-preview.1

Type alias ArangoSearchViewLinkOptions

ArangoSearchViewLinkOptions: {
    analyzers?: string[];
    cache?: boolean;
    fields?: Record<string, ArangoSearchViewLinkOptions>;
    inBackground?: boolean;
    includeAllFields?: boolean;
    nested?: Record<string, ArangoSearchViewLinkOptions>;
    storeValues?: "none" | "id";
    trackListPositions?: boolean;
}

A link definition for an ArangoSearch View.

+

Type declaration

  • Optional analyzers?: string[]

    A list of names of Analyzers to apply to values of processed document +attributes.

    +

    Default: ["identity"]

    +
  • Optional cache?: boolean

    (Enterprise Edition only.) If set to true, then field normalization +values will always be cached in memory.

    +

    Default: false

    +
  • Optional fields?: Record<string, ArangoSearchViewLinkOptions>

    An object mapping names of attributes to process for each document to +ArangoSearchViewLinkOptions definitions.

    +
  • Optional inBackground?: boolean

    If set to true, then no exclusive lock is used on the source collection +during View index creation, so that it remains basically available.

    +

    Default: false

    +
  • Optional includeAllFields?: boolean

    If set to true, all document attributes will be processed, otherwise +only the attributes in fields will be processed.

    +

    Default: false

    +
  • Optional nested?: Record<string, ArangoSearchViewLinkOptions>

    (Enterprise Edition only.) An object mapping attribute names to +ArangoSearchViewLinkOptions definitions to index sub-objects +stored in an array.

    +
  • Optional storeValues?: "none" | "id"

    Controls how the view should keep track of the attribute values.

    +

    Default: "none"

    +
  • Optional trackListPositions?: boolean

    If set to true, the position of values in array values will be tracked, +otherwise all values in an array will be treated as equal alternatives.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ArangoSearchViewPatchPropertiesOptions.html b/9.0.0-preview.1/types/view.ArangoSearchViewPatchPropertiesOptions.html new file mode 100644 index 000000000..872519d21 --- /dev/null +++ b/9.0.0-preview.1/types/view.ArangoSearchViewPatchPropertiesOptions.html @@ -0,0 +1,2 @@ +ArangoSearchViewPatchPropertiesOptions | arangojs - v9.0.0-preview.1

Type alias ArangoSearchViewPatchPropertiesOptions

ArangoSearchViewPatchPropertiesOptions: ArangoSearchViewPropertiesOptions

Options for partially modifying the properties of an ArangoSearch View.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ArangoSearchViewProperties.html b/9.0.0-preview.1/types/view.ArangoSearchViewProperties.html new file mode 100644 index 000000000..351f7f40f --- /dev/null +++ b/9.0.0-preview.1/types/view.ArangoSearchViewProperties.html @@ -0,0 +1,2 @@ +ArangoSearchViewProperties | arangojs - v9.0.0-preview.1

Type alias ArangoSearchViewProperties

ArangoSearchViewProperties: ArangoSearchViewDescription & {
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: TierConsolidationPolicy | BytesAccumConsolidationPolicy;
    links: Record<string, Omit<ArangoSearchViewLink, "nested">>;
    optimizeTopK: string[];
    primaryKeyCache: boolean;
    primarySort: {
        direction: Direction;
        field: string;
    }[];
    primarySortCache: boolean;
    primarySortCompression: Compression;
    storedValues: {
        cache: boolean;
        compression: Compression;
        fields: string[];
    }[];
    writebufferActive: number;
    writebufferIdle: number;
    writebufferSizeMax: number;
}

Properties of an ArangoSearch View.

+

Type declaration

  • cleanupIntervalStep: number
  • commitIntervalMsec: number
  • consolidationIntervalMsec: number
  • consolidationPolicy: TierConsolidationPolicy | BytesAccumConsolidationPolicy
  • links: Record<string, Omit<ArangoSearchViewLink, "nested">>
  • optimizeTopK: string[]
  • primaryKeyCache: boolean
  • primarySort: {
        direction: Direction;
        field: string;
    }[]
  • primarySortCache: boolean
  • primarySortCompression: Compression
  • storedValues: {
        cache: boolean;
        compression: Compression;
        fields: string[];
    }[]
  • writebufferActive: number
  • writebufferIdle: number
  • writebufferSizeMax: number
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ArangoSearchViewPropertiesOptions.html b/9.0.0-preview.1/types/view.ArangoSearchViewPropertiesOptions.html new file mode 100644 index 000000000..c378133cd --- /dev/null +++ b/9.0.0-preview.1/types/view.ArangoSearchViewPropertiesOptions.html @@ -0,0 +1,14 @@ +ArangoSearchViewPropertiesOptions | arangojs - v9.0.0-preview.1

Type alias ArangoSearchViewPropertiesOptions

ArangoSearchViewPropertiesOptions: {
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    links?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>;
}

Options for modifying the properties of an ArangoSearch View.

+

Type declaration

  • Optional cleanupIntervalStep?: number

    How many commits to wait between removing unused files.

    +

    Default: 2

    +
  • Optional commitIntervalMsec?: number

    How long to wait between commiting View data store changes and making +documents visible to queries.

    +

    Default: 1000

    +
  • Optional consolidationIntervalMsec?: number

    How long to wait between applying the consolidationPolicy.

    +

    Default: 10000

    +
  • Optional consolidationPolicy?: TierConsolidationPolicy

    Consolidation policy to apply for selecting which segments should be +merged.

    +

    Default: { type: "tier" }

    +
  • Optional links?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>

    An object mapping names of linked collections to +ArangoSearchViewLinkOptions definitions.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.BytesAccumConsolidationPolicy.html b/9.0.0-preview.1/types/view.BytesAccumConsolidationPolicy.html new file mode 100644 index 000000000..170656190 --- /dev/null +++ b/9.0.0-preview.1/types/view.BytesAccumConsolidationPolicy.html @@ -0,0 +1,7 @@ +BytesAccumConsolidationPolicy | arangojs - v9.0.0-preview.1

Type alias BytesAccumConsolidationPolicy

BytesAccumConsolidationPolicy: {
    threshold?: number;
    type: "bytes_accum";
}

Policy to consolidate based on segment byte size and live document count as +dictated by the customization attributes.

+

Type declaration

  • Optional threshold?: number

    Must be in the range of 0.0 to 1.0.

    +
  • type: "bytes_accum"

    Type of consolidation policy.

    +

Deprecated

The bytes_accum consolidation policy was deprecated in +ArangoDB 3.7 and should be replaced with the tier consolidation policy.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.Compression.html b/9.0.0-preview.1/types/view.Compression.html new file mode 100644 index 000000000..169cbbdae --- /dev/null +++ b/9.0.0-preview.1/types/view.Compression.html @@ -0,0 +1,2 @@ +Compression | arangojs - v9.0.0-preview.1

Type alias Compression

Compression: "lz4" | "none"

Compression for storing data.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.CreateArangoSearchViewOptions.html b/9.0.0-preview.1/types/view.CreateArangoSearchViewOptions.html new file mode 100644 index 000000000..d6f0ddeb4 --- /dev/null +++ b/9.0.0-preview.1/types/view.CreateArangoSearchViewOptions.html @@ -0,0 +1,26 @@ +CreateArangoSearchViewOptions | arangojs - v9.0.0-preview.1

Type alias CreateArangoSearchViewOptions

CreateArangoSearchViewOptions: ArangoSearchViewPropertiesOptions & {
    optimizeTopK?: string[];
    primaryKeyCache?: boolean;
    primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[];
    primarySortCache?: boolean;
    primarySortCompression?: Compression;
    storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][];
    type: "arangosearch";
    writebufferActive?: number;
    writebufferIdle?: number;
    writebufferSizeMax?: number;
}

Options for creating an ArangoSearch View.

+

Type declaration

  • Optional optimizeTopK?: string[]

    An array of strings defining sort expressions to optimize.

    +
  • Optional primaryKeyCache?: boolean

    (Enterprise Edition only.) If set to true, then primary key columns +will always be cached in memory.

    +

    Default: false

    +
  • Optional primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[]

    Attribute path (field) for the value of each document that will be +used for sorting.

    +

    If direction is set to "asc" or asc is set to true, +the primary sorting order will be ascending.

    +

    If direction is set to "desc" or asc is set to false, +the primary sorting order will be descending.

    +
  • Optional primarySortCache?: boolean

    (Enterprise Edition only.) If set to true, then primary sort columns +will always be cached in memory.

    +

    Default: false

    +
  • Optional primarySortCompression?: Compression

    Compression to use for the primary sort data.

    +

    Default: "lz4"

    +
  • Optional storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][]

    Attribute paths for which values should be stored in the view index +in addition to those used for sorting via primarySort.

    +
  • type: "arangosearch"

    Type of the View.

    +
  • Optional writebufferActive?: number

    Maximum number of concurrent active writers that perform a transaction.

    +

    Default: 0

    +
  • Optional writebufferIdle?: number

    Maximum number of writers cached in the pool.

    +

    Default: 64

    +
  • Optional writebufferSizeMax?: number

    Maximum memory byte size per writer before a writer flush is triggered.

    +

    Default: 33554432 (32 MiB)

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.CreateSearchAliasViewOptions.html b/9.0.0-preview.1/types/view.CreateSearchAliasViewOptions.html new file mode 100644 index 000000000..71cb3f2d7 --- /dev/null +++ b/9.0.0-preview.1/types/view.CreateSearchAliasViewOptions.html @@ -0,0 +1,3 @@ +CreateSearchAliasViewOptions | arangojs - v9.0.0-preview.1

Type alias CreateSearchAliasViewOptions

CreateSearchAliasViewOptions: SearchAliasViewPropertiesOptions & {
    type: "search-alias";
}

Options for creating a SearchAlias View.

+

Type declaration

  • type: "search-alias"

    Type of the View.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.CreateViewOptions.html b/9.0.0-preview.1/types/view.CreateViewOptions.html new file mode 100644 index 000000000..1a855e2db --- /dev/null +++ b/9.0.0-preview.1/types/view.CreateViewOptions.html @@ -0,0 +1,2 @@ +CreateViewOptions | arangojs - v9.0.0-preview.1

Type alias CreateViewOptions

Options for creating a View.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.Direction.html b/9.0.0-preview.1/types/view.Direction.html new file mode 100644 index 000000000..2efb2ce37 --- /dev/null +++ b/9.0.0-preview.1/types/view.Direction.html @@ -0,0 +1,2 @@ +Direction | arangojs - v9.0.0-preview.1

Type alias Direction

Direction: "desc" | "asc"

Sorting direction. Descending or ascending.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.GenericViewDescription.html b/9.0.0-preview.1/types/view.GenericViewDescription.html new file mode 100644 index 000000000..417022d14 --- /dev/null +++ b/9.0.0-preview.1/types/view.GenericViewDescription.html @@ -0,0 +1,5 @@ +GenericViewDescription | arangojs - v9.0.0-preview.1

Type alias GenericViewDescription

GenericViewDescription: {
    globallyUniqueId: string;
    id: string;
    name: string;
}

Generic description of a View.

+

Type declaration

  • globallyUniqueId: string

    A globally unique identifier for this View.

    +
  • id: string

    An identifier for this View.

    +
  • name: string

    Name of the View.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.SearchAliasViewDescription.html b/9.0.0-preview.1/types/view.SearchAliasViewDescription.html new file mode 100644 index 000000000..ba49e71f1 --- /dev/null +++ b/9.0.0-preview.1/types/view.SearchAliasViewDescription.html @@ -0,0 +1 @@ +SearchAliasViewDescription | arangojs - v9.0.0-preview.1

Type alias SearchAliasViewDescription

SearchAliasViewDescription: GenericViewDescription & {
    type: "search-alias";
}

Type declaration

  • type: "search-alias"
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.SearchAliasViewIndexOptions.html b/9.0.0-preview.1/types/view.SearchAliasViewIndexOptions.html new file mode 100644 index 000000000..63ebb303e --- /dev/null +++ b/9.0.0-preview.1/types/view.SearchAliasViewIndexOptions.html @@ -0,0 +1,4 @@ +SearchAliasViewIndexOptions | arangojs - v9.0.0-preview.1

Type alias SearchAliasViewIndexOptions

SearchAliasViewIndexOptions: {
    collection: string;
    index: string;
}

Options defining an index used in a SearchAlias View.

+

Type declaration

  • collection: string

    Name of a collection.

    +
  • index: string

    Name of an inverted index in the collection.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.SearchAliasViewPatchIndexOptions.html b/9.0.0-preview.1/types/view.SearchAliasViewPatchIndexOptions.html new file mode 100644 index 000000000..f99616f3d --- /dev/null +++ b/9.0.0-preview.1/types/view.SearchAliasViewPatchIndexOptions.html @@ -0,0 +1,4 @@ +SearchAliasViewPatchIndexOptions | arangojs - v9.0.0-preview.1

Type alias SearchAliasViewPatchIndexOptions

SearchAliasViewPatchIndexOptions: SearchAliasViewIndexOptions & {
    operation?: "add" | "del";
}

Options defining an index to be modified in a SearchAlias View.

+

Type declaration

  • Optional operation?: "add" | "del"

    Whether to add or remove the index.

    +

    Default: "add"

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.SearchAliasViewPatchPropertiesOptions.html b/9.0.0-preview.1/types/view.SearchAliasViewPatchPropertiesOptions.html new file mode 100644 index 000000000..860e8fb10 --- /dev/null +++ b/9.0.0-preview.1/types/view.SearchAliasViewPatchPropertiesOptions.html @@ -0,0 +1,3 @@ +SearchAliasViewPatchPropertiesOptions | arangojs - v9.0.0-preview.1

Type alias SearchAliasViewPatchPropertiesOptions

SearchAliasViewPatchPropertiesOptions: {
    indexes: SearchAliasViewPatchIndexOptions[];
}

Options for partially modifying the properties of a SearchAlias View.

+

Type declaration

\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.SearchAliasViewProperties.html b/9.0.0-preview.1/types/view.SearchAliasViewProperties.html new file mode 100644 index 000000000..d8d8d70ca --- /dev/null +++ b/9.0.0-preview.1/types/view.SearchAliasViewProperties.html @@ -0,0 +1,2 @@ +SearchAliasViewProperties | arangojs - v9.0.0-preview.1

Type alias SearchAliasViewProperties

SearchAliasViewProperties: SearchAliasViewDescription & {
    indexes: {
        collection: string;
        index: string;
    }[];
}

Properties of a SearchAlias View.

+

Type declaration

  • indexes: {
        collection: string;
        index: string;
    }[]
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.SearchAliasViewPropertiesOptions.html b/9.0.0-preview.1/types/view.SearchAliasViewPropertiesOptions.html new file mode 100644 index 000000000..fb0ad0027 --- /dev/null +++ b/9.0.0-preview.1/types/view.SearchAliasViewPropertiesOptions.html @@ -0,0 +1,3 @@ +SearchAliasViewPropertiesOptions | arangojs - v9.0.0-preview.1

Type alias SearchAliasViewPropertiesOptions

SearchAliasViewPropertiesOptions: {
    indexes: SearchAliasViewIndexOptions[];
}

Options for modifying the properties of a SearchAlias View.

+

Type declaration

\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.TierConsolidationPolicy.html b/9.0.0-preview.1/types/view.TierConsolidationPolicy.html new file mode 100644 index 000000000..4c2f34d79 --- /dev/null +++ b/9.0.0-preview.1/types/view.TierConsolidationPolicy.html @@ -0,0 +1,17 @@ +TierConsolidationPolicy | arangojs - v9.0.0-preview.1

Type alias TierConsolidationPolicy

TierConsolidationPolicy: {
    minScore?: number;
    segmentsBytesFloor?: number;
    segmentsBytesMax?: number;
    segmentsMax?: number;
    segmentsMin?: number;
    type: "tier";
}

Policy to consolidate if the sum of all candidate segment byte size is less +than the total segment byte size multiplied by a given threshold.

+

Type declaration

  • Optional minScore?: number

    Consolidation candidates with a score less than this value will be +filtered out.

    +

    Default: 0

    +
  • Optional segmentsBytesFloor?: number

    Size below which all segments are treated as equivalent.

    +

    Default: 2097152 (2 MiB)

    +
  • Optional segmentsBytesMax?: number

    Maximum allowed size of all consolidation segments.

    +

    Default: 5368709120 (5 GiB)

    +
  • Optional segmentsMax?: number

    Maximum number of segments that are evaluated as candidates for +consolidation.

    +

    Default: 10

    +
  • Optional segmentsMin?: number

    Minimum number of segments that are evaluated as candidates for +consolidation.

    +

    Default: 1

    +
  • type: "tier"

    Type of consolidation policy.

    +
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ViewDescription.html b/9.0.0-preview.1/types/view.ViewDescription.html new file mode 100644 index 000000000..ec6b8ccdc --- /dev/null +++ b/9.0.0-preview.1/types/view.ViewDescription.html @@ -0,0 +1 @@ +ViewDescription | arangojs - v9.0.0-preview.1
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ViewPatchPropertiesOptions.html b/9.0.0-preview.1/types/view.ViewPatchPropertiesOptions.html new file mode 100644 index 000000000..1b666e70e --- /dev/null +++ b/9.0.0-preview.1/types/view.ViewPatchPropertiesOptions.html @@ -0,0 +1,2 @@ +ViewPatchPropertiesOptions | arangojs - v9.0.0-preview.1

Type alias ViewPatchPropertiesOptions

Options for partially modifying a View's properties.

+
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ViewProperties.html b/9.0.0-preview.1/types/view.ViewProperties.html new file mode 100644 index 000000000..374734da6 --- /dev/null +++ b/9.0.0-preview.1/types/view.ViewProperties.html @@ -0,0 +1 @@ +ViewProperties | arangojs - v9.0.0-preview.1
\ No newline at end of file diff --git a/9.0.0-preview.1/types/view.ViewPropertiesOptions.html b/9.0.0-preview.1/types/view.ViewPropertiesOptions.html new file mode 100644 index 000000000..44095e168 --- /dev/null +++ b/9.0.0-preview.1/types/view.ViewPropertiesOptions.html @@ -0,0 +1,2 @@ +ViewPropertiesOptions | arangojs - v9.0.0-preview.1

Type alias ViewPropertiesOptions

Options for replacing a View's properties.

+
\ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 221f809f0..c68b840fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,76 @@ This driver uses semantic versioning: - A change in the major version (e.g. 1.Y.Z -> 2.0.0) indicates _breaking_ changes that require changes in your code to upgrade. +## [9.0.0-preview.1] + +This is a major release and breaks backwards compatibility. + +See [the migration guide](./MIGRATING.md#v8-to-v9) for detailed instructions +for upgrading your code to arangojs v9. + +### Removed + +- Removed Node.js 14 and Node.js 16 support + + With Node.js 14 and 16 having reached their end of life, arangojs will no + longer support these versions of Node.js going forward. + + For more information, see [the Node.js release schedule](https://nodejs.dev/en/about/releases/). + +- Removed `Params` and `Headers` types + + These can mostly be replaced with the native `URLSearchParams` and `Headers` + types but most public methods still accept the equivalent `Record` types for + convenience. + +- Removed deprecated `FulltextIndex` and related types + + Fulltext indexes have been deprecated in ArangoDB 3.10 and should be replaced + with ArangoSearch. + +- Removed browser build + + The browser build has been removed from the repository and will no longer be + published to npm. The npm package can still be used in the browser by using + common frontend tooling like webpack or rollup. + +### Changed + +- Replaced request logic with native `fetch` API ([#788](https://github.com/arangodb/arangojs/issues/788), DE-578, DE-758) + + The node-specific request logic using the `http` and `https` modules has been + replaced with all-new logic using the web standard `fetch` API, which should + work in Node.js, browsers and other conformant environments. + +- Unicode names are now **no longer** automatically NFC normalized (DE-65) + + This change affects all database, collection, graph, view and analyzer names + using unicode characters. Starting with arangojs v7.7.0 these names were + automatically NFC normalized. This behavior has now been reverted to match + the behavior of other ArangoDB drivers and help detect normalization issues + in user code. + +- Changed return type of `aql` and the AQL `join` helper function to `AqlQuery` + + Previously the internal `GeneratedAqlQuery` type was exposed as the return + type of these functions, leading to complexity when handling generic type + arguments. + +- Removed dependency on Node `path` module or its browserify equivalent + + This change should be backwards-compatible but may produce different results + when using non-normalized paths and base-paths in custom `routes`. This + should help support more environments and reduce the size of the browser + bundle. + +### Added + +- Added ESM support (DE-236) + + The driver now supports being imported as an ES module or CommonJS module + and provides exports for both types of environments. This change should be + backwards-compatible. + ## [8.8.1] ### Added @@ -1799,6 +1869,7 @@ For a detailed list of changes between pre-release versions of v7 see the Graph methods now only return the relevant part of the response body. +[9.0.0-preview.1]: https://github.com/arangodb/arangojs/compare/v8.8.1...v9.0.0-preview.1 [8.8.1]: https://github.com/arangodb/arangojs/compare/v8.8.0...v8.8.1 [8.8.0]: https://github.com/arangodb/arangojs/compare/v8.7.0...v8.8.0 [8.7.0]: https://github.com/arangodb/arangojs/compare/v8.6.0...v8.7.0 diff --git a/MIGRATING.md b/MIGRATING.md index 81a087820..c3c3aab15 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -5,6 +5,93 @@ title: "Migrating" # Migrating +## v8 to v9 + +Version 9 reverts the automatic NFC normalization introduced in v7.7.0. This +means that arangojs will no longer automatically normalize unicode names and +identifiers of collections, graphs, indexes, views, users, databases and so on. + +If you want to continue using NFC normalization, you can use the `normalize` +method available on all JavaScript strings: + +```diff + import { Database } from "arangojs"; + + const db = new Database(); +-const collection = db.collection(myUnicodeName); ++const collection = db.collection(myUnicodeName.normalize("NFC")); +``` + +Note that ArangoDB may reject non-normalized unicode names and identifiers. +This change is intended to make it easier to recognize normalization issues in +code interacting with ArangoDB that were previously masked by arangojs. + +### Request and Response changes + +Version 9 now uses native `fetch` in all environments. This means that the +request and response objects exposed by ArangoJS now extend the fetch API's +`Request` and `Response` objects rather than those from Node's `http` module +and ArangoJS no longer provides the `agentOptions` or `agent` config options. + +#### Config changes + +The relevant `agentOptions` have been moved up into the `config` type and +in most cases renamed: + +```diff + const db = new Database({ + url: "http://localhost:8529", +- agentOptions: { +- maxSockets: 10, +- keepAlive: true, +- before: (req) => console.log(String(new Date()), 'requesting', req.url), +- after: (res) => console.log(String(new Date()), 'received', res.request.url) +- } ++ poolSize: 10, ++ keepalive: true, ++ beforeRequest: (req) => console.log(String(new Date()), 'requesting', req.url), ++ afterResponse: (res) => console.log(String(new Date()), 'received', res.request.url) + }); +``` + +If you need to modify the request agent beyond what is possible using the fetch +API, you can override Node's default `fetch` Agent using the `undici` module: + +```js +const { Agent, setGlobalDispatcher } = require("undici"); + +setGlobalDispatcher( + new Agent({ + // your agent options here + }) +); +``` + +Note that you will have to add `undici` as a dependency to your project. There +is currently no built-in way to override these options in Node.js without this +module. + +#### Request and Response objects + +This change mostly affects code that uses the `db.route` API to perform +arbitrary requests to the ArangoDB HTTP API. + +The fetch API `Request` and `Response` objects are a bit different from the +equivalent objects previously exposed by these methods. Note that while this +means response objects still provide a `body` property, its semantics are very +different as the fetch API expects the `blob`, `json` and `text` methods to be +used instead. ArangoJS will use the relevant method during response handling +and store the result in the `parsedBody` method: + +```diff + const myFoxxApi = db.route('my/foxx'); + const res = await myFoxxApi.get(); +- const token = res.headers['x-auth-token']; +- if (res.statusCode === 200) console.log(res.body); ++ const token = res.headers.get('x-auth-token'); ++ if (res.status === 200) console.log(res.parsedBody); +``` + ## v7 to v8 Version 8 drops support for Internet Explorer 11 and Node.js 10 and 12. If you diff --git a/VERSION.md b/VERSION.md index efcaae2e5..a09c17421 100644 --- a/VERSION.md +++ b/VERSION.md @@ -2,4 +2,4 @@ permalink: /VERSION title: "VERSION" --- -7.0.0-rc.1 +9.0.0-preview.1 diff --git a/latest b/latest index a2931d315..be3bfef64 120000 --- a/latest +++ b/latest @@ -1 +1 @@ -7.5.0 \ No newline at end of file +9.0.0-preview.1 \ No newline at end of file