Type Alias ListDocumentsData

type ListDocumentsData = {
    body?: never;
    path: { index: IndexName; organization: Name };
    query?: {
        amount?: number;
        delimiter?: string;
        page?: string;
        prefix?: string;
    };
    url: "/organizations/{organization}/indexes/{index}/objects";
}

Index

Properties

body? path query? url

Properties

`Optional`body

body?: never

path

path: { index: IndexName; organization: Name }

`Optional`query

query?: { amount?: number; delimiter?: string; page?: string; prefix?: string }

Type Declaration

Optionalamount?: number
Optionaldelimiter?: string

Folds documents that share the substring through the first delimiter after prefix into one common prefix.
Optionalpage?: string
Optionalprefix?: string

url

url: "/organizations/{organization}/indexes/{index}/objects"