Merge pull request #539 from moreal/docs-typo-more

Fix several JSDoc typos and incorrect references

Author: dahlia

packages/cli/src/webfinger/lib.ts

@@ -21,14 +21,14 @@ export function convertUrlIfHandle(handleOrUrl: string): URL {
 
 /**
  * Converts a handle in the format `@username@domain` to a URL.
- * The resulting URL will be in the format `https://domain/@username`.
+ * The resulting URL will be in the format `acct:username@domain`.
  * @param handle The handle to convert, in the format `@username@domain`.
  * @returns A URL object representing the handle.
  * @throws {Error} If the handle format is invalid.
  * @example
  * ```ts
  * const url = convertHandleToUrl("@[email protected]");
- * console.log(url.toString()); // "https://domain.com/@username"
+ * console.log(url.toString()); // "acct:username@domain.com"
  * ```
  */
 export function convertHandleToUrl(handle: string): URL {

packages/denokv/src/mod.ts

@@ -38,7 +38,7 @@ export class DenoKvStore implements KvStore {
   }
 
   /**
-   * {@inheritDoc KvStore.set}
+   * {@inheritDoc KvStore.get}
    */
   async get<T = unknown>(key: KvKey): Promise<T | undefined> {
     const entry = await this.#kv.get<T>(key);

packages/fedify/src/federation/context.ts

@@ -116,7 +116,7 @@ export interface Context<TContextData> {
    * @param cls The class of the object.
    * @param values The values to pass to the object dispatcher.
    * @returns The object's URI.
-   * @throws {RouteError} If no object dispatcher is available for the class.
+   * @throws {RouterError} If no object dispatcher is available for the class.
    * @throws {TypeError} If values are invalid.
    * @since 0.7.0
    */
@@ -383,7 +383,7 @@ export interface Context<TContextData> {
   ): Promise<void>;
 
   /**
-   * Sends an activity to the outboxes of the sender's followers.
+   * Sends an activity to the inboxes of the sender's followers.
    * @param sender The sender's identifier or the sender's username.
    * @param recipients In this case, it must be `"followers"`.
    * @param activity The activity to send.
@@ -429,7 +429,7 @@ export interface Context<TContextData> {
    * @param name The name of the collection, which can be a string or a symbol.
    * @param values The values of the URI parameters.
    * @return The URI of the collection.
-   * @throws {RouteError} If no object dispatcher is available for the name.
+   * @throws {RouterError} If no object dispatcher is available for the name.
    * @throws {TypeError} If values are invalid.
    * @since 1.8.0
    */

packages/fedify/src/federation/federation.ts

@@ -468,7 +468,7 @@ export interface Federatable<TContextData> {
    *                        ([RFC 6570](https://tools.ietf.org/html/rfc6570)).
    *                        The path must have no variables.
    * @returns An object to register inbox listeners.
-   * @throws {RouteError} Thrown if the path pattern is invalid.
+   * @throws {RouterError} Thrown if the path pattern is invalid.
    */
   setInboxListeners(
     inboxPath:

packages/fedify/src/testing/context.ts

@@ -50,7 +50,7 @@ export function createContext<TContextData>(
     sendActivity,
     routeActivity,
   } = values;
-  function throwRouteError(): URL {
+  function throwRouterError(): URL {
     throw new RouterError("Not implemented");
   }
   return {
@@ -64,17 +64,17 @@ export function createContext<TContextData>(
     contextLoader: contextLoader ?? mockDocumentLoader,
     tracerProvider: tracerProvider ?? trace.getTracerProvider(),
     clone: clone ?? ((data) => createContext({ ...values, data })),
-    getNodeInfoUri: getNodeInfoUri ?? throwRouteError,
-    getActorUri: getActorUri ?? throwRouteError,
-    getObjectUri: getObjectUri ?? throwRouteError,
-    getCollectionUri: getCollectionUri ?? throwRouteError,
-    getOutboxUri: getOutboxUri ?? throwRouteError,
-    getInboxUri: getInboxUri ?? throwRouteError,
-    getFollowingUri: getFollowingUri ?? throwRouteError,
-    getFollowersUri: getFollowersUri ?? throwRouteError,
-    getLikedUri: getLikedUri ?? throwRouteError,
-    getFeaturedUri: getFeaturedUri ?? throwRouteError,
-    getFeaturedTagsUri: getFeaturedTagsUri ?? throwRouteError,
+    getNodeInfoUri: getNodeInfoUri ?? throwRouterError,
+    getActorUri: getActorUri ?? throwRouterError,
+    getObjectUri: getObjectUri ?? throwRouterError,
+    getCollectionUri: getCollectionUri ?? throwRouterError,
+    getOutboxUri: getOutboxUri ?? throwRouterError,
+    getInboxUri: getInboxUri ?? throwRouterError,
+    getFollowingUri: getFollowingUri ?? throwRouterError,
+    getFollowersUri: getFollowersUri ?? throwRouterError,
+    getLikedUri: getLikedUri ?? throwRouterError,
+    getFeaturedUri: getFeaturedUri ?? throwRouterError,
+    getFeaturedTagsUri: getFeaturedTagsUri ?? throwRouterError,
     parseUri: parseUri ?? ((_uri) => {
       throw new Error("Not implemented");
     }),

packages/testing/src/context.ts

@@ -76,7 +76,7 @@ function createContext<TContextData>(
     sendActivity,
     routeActivity,
   } = values;
-  function throwRouteError(): URL {
+  function throwRouterError(): URL {
     throw new RouterError("Not implemented");
   }
   return {
@@ -90,17 +90,17 @@ function createContext<TContextData>(
     contextLoader: contextLoader ?? mockDocumentLoader,
     tracerProvider: tracerProvider ?? noopTracerProvider,
     clone: clone ?? ((data) => createContext({ ...values, data })),
-    getNodeInfoUri: getNodeInfoUri ?? throwRouteError,
-    getActorUri: getActorUri ?? throwRouteError,
-    getObjectUri: getObjectUri ?? throwRouteError,
-    getCollectionUri: getCollectionUri ?? throwRouteError,
-    getOutboxUri: getOutboxUri ?? throwRouteError,
-    getInboxUri: getInboxUri ?? throwRouteError,
-    getFollowingUri: getFollowingUri ?? throwRouteError,
-    getFollowersUri: getFollowersUri ?? throwRouteError,
-    getLikedUri: getLikedUri ?? throwRouteError,
-    getFeaturedUri: getFeaturedUri ?? throwRouteError,
-    getFeaturedTagsUri: getFeaturedTagsUri ?? throwRouteError,
+    getNodeInfoUri: getNodeInfoUri ?? throwRouterError,
+    getActorUri: getActorUri ?? throwRouterError,
+    getObjectUri: getObjectUri ?? throwRouterError,
+    getCollectionUri: getCollectionUri ?? throwRouterError,
+    getOutboxUri: getOutboxUri ?? throwRouterError,
+    getInboxUri: getInboxUri ?? throwRouterError,
+    getFollowingUri: getFollowingUri ?? throwRouterError,
+    getFollowersUri: getFollowersUri ?? throwRouterError,
+    getLikedUri: getLikedUri ?? throwRouterError,
+    getFeaturedUri: getFeaturedUri ?? throwRouterError,
+    getFeaturedTagsUri: getFeaturedTagsUri ?? throwRouterError,
     parseUri: parseUri ?? ((_uri) => {
       throw new Error("Not implemented");
     }),

packages/vocab-runtime/src/docloader.ts

@@ -269,7 +269,7 @@ export interface GetDocumentLoaderOptions extends DocumentLoaderFactoryOptions {
  * Creates a JSON-LD document loader that utilizes the browser's `fetch` API.
  *
  * The created loader preloads the below frequently used contexts by default
- * (unless `options.ignorePreloadedContexts` is set to `true`):
+ * (unless `options.skipPreloadedContexts` is set to `true`):
  *
  * - <https://www.w3.org/ns/activitystreams>
  * - <https://w3id.org/security/v1>

packages/vocab-runtime/src/langstr.ts

@@ -11,8 +11,8 @@ export class LanguageString extends String {
   /**
    * Constructs a new `LanguageString`.
    * @param value A string value written in the given language.
-   * @param locale The language of the string.  If a string is given, it will
-   *               be parsed as a `Intl.Locale` object.
+   * @param language The language of the string.  If a string is given, it will
+   *                 be parsed as a `Intl.Locale` object.
    */
   constructor(value: string, language: Intl.Locale | string) {
     super(value);

packages/vocab-tools/src/schema.ts

@@ -283,7 +283,7 @@ async function loadSchema(path: string): Promise<TypeSchema> {
 /**
  * Loads all schema files in the directory.
  * @param dir The path of the directory to load schema files from.
- * @returns A map from the qualified URI of a type to its {@link SchemaFile}.
+ * @returns A map from the qualified URI of a type to its {@link TypeSchema}.
  * @throws {@link AggregateError} if any schema file is invalid.  It contains
  *         all {@link SchemaError}s of the invalid schema files.
  */

packages/webfinger/src/lookup.ts

@@ -57,7 +57,6 @@ export interface LookupWebFingerOptions {
   /**
    * AbortSignal for cancelling the request.
    * @since 1.8.0
-   * @
    */
   signal?: AbortSignal;
 }