Interface GroupListOptions

All fields are optional — omit any to leave that filter unconstrained.

interface GroupListOptions {
    limit?: number;
    orderBy?: GroupOrderBy;
    search?: string;
}

Properties

limit?: number

Caps the total number of groups the stream yields across the whole iteration. Omit to iterate every match.

Field to sort by. Defaults to "name".

search?: string

Free-text search against the group's name.