Skip to content
4 changes: 2 additions & 2 deletions packages/cli/src/webfinger/lib.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The JSDoc description for convertHandleToUrl was updated to correctly reflect the acct:username@domain format. This improves the accuracy of the documentation.

* @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"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The example in the JSDoc for convertHandleToUrl was updated to show the correct acct:[email protected] URI format. This ensures the example is consistent with the function's behavior.

* ```
*/
export function convertHandleToUrl(handle: string): URL {
Expand Down
2 changes: 1 addition & 1 deletion packages/denokv/src/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export class DenoKvStore implements KvStore {
}

/**
* {@inheritDoc KvStore.set}
* {@inheritDoc KvStore.get}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The {@inheritDoc} reference for the get method was correctly updated from KvStore.set to KvStore.get. This ensures the documentation inherits from the correct method.

*/
async get<T = unknown>(key: KvKey): Promise<T | undefined> {
const entry = await this.#kv.get<T>(key);
Expand Down
6 changes: 3 additions & 3 deletions packages/fedify/src/federation/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The JSDoc reference for RouteError was corrected to RouterError. This aligns the documentation with the actual error class name.

* @throws {TypeError} If values are invalid.
* @since 0.7.0
*/
Expand Down Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The JSDoc description for Context.sendActivity was updated from "outboxes" to "inboxes". This clarifies the destination of the activity.

* @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.
Expand Down Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The JSDoc reference for RouteError was corrected to RouterError. This aligns the documentation with the actual error class name.

* @throws {TypeError} If values are invalid.
* @since 1.8.0
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/fedify/src/federation/federation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The JSDoc reference for RouteError was corrected to RouterError. This aligns the documentation with the actual error class name.

*/
setInboxListeners(
inboxPath:
Expand Down
24 changes: 12 additions & 12 deletions packages/fedify/src/testing/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export function createContext<TContextData>(
sendActivity,
routeActivity,
} = values;
function throwRouteError(): URL {
function throwRouterError(): URL {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The function name throwRouteError was correctly updated to throwRouterError to match the RouterError class. This improves code consistency.

throw new RouterError("Not implemented");
}
return {
Expand All @@ -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,
Comment on lines +67 to +77
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

References to throwRouteError were consistently updated to throwRouterError across multiple assignments. This ensures all references point to the correct function.

parseUri: parseUri ?? ((_uri) => {
throw new Error("Not implemented");
}),
Expand Down
24 changes: 12 additions & 12 deletions packages/testing/src/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ function createContext<TContextData>(
sendActivity,
routeActivity,
} = values;
function throwRouteError(): URL {
function throwRouterError(): URL {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The function name throwRouteError was correctly updated to throwRouterError to match the RouterError class. This improves code consistency.

throw new RouterError("Not implemented");
}
return {
Expand All @@ -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,
Comment on lines +93 to +103
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

References to throwRouteError were consistently updated to throwRouterError across multiple assignments. This ensures all references point to the correct function.

parseUri: parseUri ?? ((_uri) => {
throw new Error("Not implemented");
}),
Expand Down
2 changes: 1 addition & 1 deletion packages/vocab-runtime/src/docloader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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`):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The JSDoc reference for options.ignorePreloadedContexts was corrected to options.skipPreloadedContexts. This aligns the documentation with the actual option name.

*
* - <https://www.w3.org/ns/activitystreams>
* - <https://w3id.org/security/v1>
Expand Down
4 changes: 2 additions & 2 deletions packages/vocab-runtime/src/langstr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The @param name in the JSDoc was corrected from locale to language to match the actual parameter name in the constructor signature. This improves documentation accuracy.

* be parsed as a `Intl.Locale` object.
*/
constructor(value: string, language: Intl.Locale | string) {
super(value);
Expand Down
2 changes: 1 addition & 1 deletion packages/vocab-tools/src/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The JSDoc return type reference was corrected from SchemaFile to TypeSchema. This ensures the documentation accurately reflects the returned type.

* @throws {@link AggregateError} if any schema file is invalid. It contains
* all {@link SchemaError}s of the invalid schema files.
*/
Expand Down
1 change: 0 additions & 1 deletion packages/webfinger/src/lookup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ export interface LookupWebFingerOptions {
/**
* AbortSignal for cancelling the request.
* @since 1.8.0
* @
*/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

An orphan @ symbol was removed from the JSDoc comment. This is a minor cleanup that improves readability.

signal?: AbortSignal;
}
Expand Down
Loading