Tweak docs

Author: pluma

.github/workflows/docs.yml

@@ -71,13 +71,13 @@ jobs:
       - name: Rebuild docs for tag
         if: env.VERSION != 'devel'
         run: |
-          ./node_modules/.bin/typedoc --gitRevision ${{ github.ref_name }} --out gh-pages/${VERSION} --sourceLinkTemplate https://github.com/${{ github.repository }}/blob/${{ github.ref_name }}/src/{path}:{line}
+          ./node_modules/.bin/typedoc --includeVersion --out gh-pages/${VERSION} --sourceLinkTemplate "https://github.com/${{ github.repository }}/blob/${{ github.ref_name }}/src/{path}:{line}"
           node -p 'var all=fs.readdirSync("gh-pages",{withFileTypes:true}).flatMap(f=>f.isDirectory()&&!isNaN(f.name.charAt(0))?[f.name]:[]).sort(require("semver").rcompare);JSON.stringify({all,stable:all.filter(s=>!s.includes("-"))})' > gh-pages/_data/versions.json
 
       - name: Rebuild docs for devel
         if: env.VERSION == 'devel'
         run: |
-          ./node_modules/.bin/typedoc --gitRevision ${{ github.sha }} --out gh-pages/${VERSION} --sourceLinkTemplate https://github.com/${{ github.repository }}/blob/${{ github.sha }}/src/{path}:{line}
+          ./node_modules/.bin/typedoc --out gh-pages/${VERSION} --sourceLinkTemplate https://github.com/${{ github.repository }}/blob/${{ github.sha }}/src/{path}:{line}
 
       - name: Commit to gh-pages
         uses: EndBug/add-and-commit@v9

CHANGELOG.md

@@ -47,6 +47,11 @@ for upgrading your code to arangojs v10.
 
   The following options were moved: `credentials`, `headers` and `keepalive`.
 
+- `db.setUserAccessLevel` now takes `grant` as a separate parameter
+
+  The parameter was previously passed as an additional property in the
+  `options` parameter.
+
 #### Error handling
 
 - Errors encountered before a request completes are now wrapped in a

src/analyzers.ts

@@ -8,8 +8,8 @@
  *
  * @packageDocumentation
  */
-import * as databases from "./databases.js";
 import * as connection from "./connection.js";
+import * as databases from "./databases.js";
 import * as errors from "./errors.js";
 import { ANALYZER_NOT_FOUND } from "./lib/codes.js";
 
@@ -75,7 +75,10 @@ export type CreateAnalyzerOptions =
   | CreateGeoPointAnalyzerOptions
   | CreateGeoS2AnalyzerOptions;
 
-type CreateAnalyzerOptionsType<
+/**
+ * Shared attributes of all Analyzer creation options.
+ */
+export type CreateAnalyzerOptionsType<
   Type extends AnalyzerType,
   Properties = void,
 > = Properties extends void
@@ -580,7 +583,7 @@ export type AnalyzerDescription =
 /**
  * Shared attributes of all Analyzer descriptions.
  */
-type AnalyzerDescriptionType<
+export type AnalyzerDescriptionType<
   Type extends string,
   Properties = Record<string, never>,
 > = {
@@ -931,7 +934,7 @@ export class Analyzer {
    * ```
    */
   create<Options extends CreateAnalyzerOptions>(
-    options: Options,
+    options: Options
   ): Promise<
     Options extends CreateIdentityAnalyzerOptions
       ? IdentityAnalyzerDescription
@@ -991,7 +994,7 @@ export class Analyzer {
    * ```
    */
   drop(
-    force: boolean = false,
+    force: boolean = false
   ): Promise<connection.ArangoApiResponse<{ name: string }>> {
     return this._db.request({
       method: "DELETE",

src/databases.ts

@@ -1855,8 +1855,7 @@ export class Database {
    * given collection in the given database.
    *
    * @param username - Name of the ArangoDB user to fetch the access level for.
-   * @param database - Database to fetch the access level for.
-   * @param collection - Collection to fetch the access level for.
+   * @param options - Collection and/or database to fetch the access level for.
    *
    * @example
    * ```js
@@ -1921,8 +1920,9 @@ export class Database {
    */
   getUserAccessLevel(
     username: string,
-    { database, collection }: users.UserAccessLevelOptions
+    options: users.UserAccessLevelOptions
   ): Promise<users.AccessLevel> {
+    const { database, collection } = options;
     const databaseName = isArangoDatabase(database)
       ? database.name
       : (database ??
@@ -1951,8 +1951,7 @@ export class Database {
    * given collection in the given database.
    *
    * @param username - Name of the ArangoDB user to set the access level for.
-   * @param database - Database to set the access level for.
-   * @param collection - Collection to set the access level for.
+   * @param options - Database and/or collection to set the access level for.
    * @param grant - Access level to set for the given user.
    *
    * @example
@@ -2020,12 +2019,10 @@ export class Database {
    */
   setUserAccessLevel(
     username: string,
-    {
-      database,
-      collection,
-      grant,
-    }: users.UserAccessLevelOptions & { grant: users.AccessLevel }
+    options: users.UserAccessLevelOptions,
+    grant: users.AccessLevel
   ): Promise<connection.ArangoApiResponse<Record<string, users.AccessLevel>>> {
+    const { database, collection } = options;
     const databaseName = isArangoDatabase(database)
       ? database.name
       : (database ??
@@ -2056,8 +2053,7 @@ export class Database {
    * given collection in the given database.
    *
    * @param username - Name of the ArangoDB user to clear the access level for.
-   * @param database - Database to clear the access level for.
-   * @param collection - Collection to clear the access level for.
+   * @param options - Database and/or collection to clear the access level for.
    *
    * @example
    * ```js
@@ -2116,8 +2112,9 @@ export class Database {
    */
   clearUserAccessLevel(
     username: string,
-    { database, collection }: users.UserAccessLevelOptions
+    options: users.UserAccessLevelOptions
   ): Promise<connection.ArangoApiResponse<Record<string, users.AccessLevel>>> {
+    const { database, collection } = options;
     const databaseName = isArangoDatabase(database)
       ? database.name
       : (database ??
@@ -2393,7 +2390,7 @@ export class Database {
    *
    * See also {@link Database#beginTransaction}.
    *
-   * @param id - The `id` of an existing stream transaction.
+   * @param transactionId - The `id` of an existing stream transaction.
    *
    * @example
    * ```js
@@ -3875,7 +3872,7 @@ export class Database {
    * {@link Database#getServiceDependencies}.
    *
    * @param mount - The service's mount point, relative to the database.
-   * @param cfg - An object mapping dependency aliases to mount points.
+   * @param deps - An object mapping dependency aliases to mount points.
    * @param minimal - 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.
@@ -3911,7 +3908,7 @@ export class Database {
    * {@link Database#getServiceDependencies}.
    *
    * @param mount - The service's mount point, relative to the database.
-   * @param cfg - An object mapping dependency aliases to mount points.
+   * @param deps - An object mapping dependency aliases to mount points.
    * @param minimal - 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.
@@ -3960,7 +3957,7 @@ export class Database {
    * {@link Database#getServiceDependencies}.
    *
    * @param mount - The service's mount point, relative to the database.
-   * @param cfg - An object mapping dependency aliases to mount points.
+   * @param deps - An object mapping dependency aliases to mount points.
    * @param minimal - 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.
@@ -3996,7 +3993,7 @@ export class Database {
    * {@link Database#getServiceDependencies}.
    *
    * @param mount - The service's mount point, relative to the database.
-   * @param cfg - An object mapping dependency aliases to mount points.
+   * @param deps - An object mapping dependency aliases to mount points.
    * @param minimal - 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.