@uploadcare/rest-client
    Preparing search index...

    Type Alias SearchFilesOptions

    At least one condition is required: query, phrase, exact, datetimeUploaded, size, isImage or tags. Conditions combine with AND.

    type SearchFilesOptions = {
        datetimeUploaded?: SearchFilesRange<Date | string>;
        exact?: SearchFilesExact;
        fuzziness?: boolean;
        include?: "appdata";
        isImage?: boolean;
        limit?: number;
        offset?: number;
        phrase?: SearchFilesPhrase;
        query?: string;
        size?: SearchFilesRange<number>;
        sort?: SearchFilesSort[];
        tags?: SearchFilesTags;
    }
    Index

    Properties

    datetimeUploaded? exact? fuzziness? include? isImage? limit? offset? phrase? query? size? sort? tags?

    Properties

    datetimeUploaded?: SearchFilesRange<Date | string>
    exact?: SearchFilesExact
    fuzziness?: boolean

    Typo tolerance for query and phrase. Slower. Defaults to false.

    include?: "appdata"
    isImage?: boolean

    false excludes images.

    limit?: number

    1 to 100, defaults to 20.

    offset?: number

    offset + limit must stay under 1000.

    phrase?: SearchFilesPhrase
    query?: string

    Full-text across searchable fields, at least 4 characters.

    size?: SearchFilesRange<number>

    File size in bytes.

    sort?: SearchFilesSort[]

    Up to 4 keys, applied in the order given. Defaults to relevance, which is not stable between pages: give an explicit sort when paginating, or a page can repeat a file an earlier one already returned.

    tags?: SearchFilesTags

    Settings

    Member Visibility

    On This Page

    Properties