Type Alias Users

type Users = {
    data?: User[];
    links?: {
        next?: { href: string };
        prev?: { href: string };
        self: { href: string };
    };
    totalResults?: number;
}
Index

Properties

data? links? totalResults?

Properties

data?: User[]

List of users.

links?: {
    next?: { href: string };
    prev?: { href: string };
    self: { href: string };
}

Pagination links

Type declaration

  • Optionalnext?: { href: string }

    Link information for next page

    • href: string

      URL to the next page of records

  • Optionalprev?: { href: string }

    Link information for previous page

    • href: string

      URL to the previous page of records

  • self: { href: string }

    Link information for current page

    • href: string

      URL to the current page of records

totalResults?: number

Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true.

Settings

Member Visibility

On This Page

Properties