diff --git a/.changeset/healthy-ducks-drive.md b/.changeset/healthy-ducks-drive.md new file mode 100644 index 000000000..5789d2220 --- /dev/null +++ b/.changeset/healthy-ducks-drive.md @@ -0,0 +1,6 @@ +--- +'@verdaccio/types': patch +'@verdaccio/config': patch +--- + +chore: fix typedocs warnings diff --git a/packages/config/src/user.ts b/packages/config/src/user.ts index fdeb9bf2e..a31bac56f 100644 --- a/packages/config/src/user.ts +++ b/packages/config/src/user.ts @@ -25,7 +25,7 @@ export const defaultNonLoggedUserRoles = [ /** * Create a RemoteUser object - * @return {Object} { name: xx, pluginGroups: [], real_groups: [] } + * @return {Object} \{ name: xx, pluginGroups: [], real_groups: [] \} */ export function createRemoteUser(name: string, pluginGroups: string[]): RemoteUser { const isGroupValid: boolean = Array.isArray(pluginGroups); @@ -42,7 +42,7 @@ export function createRemoteUser(name: string, pluginGroups: string[]): RemoteUs /** * Builds an anonymous remote user in case none is logged in. - * @return {Object} { name: xx, groups: [], real_groups: [] } + * @return {Object} \{ name: xx, groups: [], real_groups: [] \} */ export function createAnonymousRemoteUser(): RemoteUser { return { diff --git a/packages/core/types/src/plugins/storage.ts b/packages/core/types/src/plugins/storage.ts index 41304a350..a7939bdb9 100644 --- a/packages/core/types/src/plugins/storage.ts +++ b/packages/core/types/src/plugins/storage.ts @@ -23,11 +23,11 @@ export interface ITokenActions { /** * This method expect return a Package object * eg: - * { + * \{ * name: string; * time: number; * ... and other props - * } + * \} * * The `cb` callback object will be executed if: * - it might return object (truly)