0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00

chore: fix typedocs warnings (#4946)

This commit is contained in:
Marc Bernard 2024-11-16 04:43:39 -05:00 committed by GitHub
parent a049bba201
commit 4adaa833ba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 10 additions and 4 deletions

View file

@ -0,0 +1,6 @@
---
'@verdaccio/types': patch
'@verdaccio/config': patch
---
chore: fix typedocs warnings

View file

@ -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 {

View file

@ -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)