@audiotool/nexus - v0.0.17
    Preparing search index...

    Type Alias SampleListOptions

    Options for listing samples.

    type SampleListOptions = {
        filter?: string;
        orderBy?: string;
        pageSize?: number;
        pageToken?: string;
        textSearch?: string;
    }
    Index

    Properties

    filter? orderBy? pageSize? pageToken? textSearch?

    Properties

    filter?: string

    CEL filter expression. Supported fields:

    • sample.name, sample.display_name, sample.description
    • sample.owner_name, sample.num_favorites, sample.num_usages
    • sample.bpm, sample.sample_type, sample.play_duration
    • sample.create_time, sample.update_time
    • sample.clearance, sample.tags, sample.favorited_by_user
    orderBy?: string

    Sort order. Supported fields match filter fields.

    "sample.create_time desc"
    pageSize?: number

    Maximum number of results to return.

    20
    pageToken?: string

    Token from a previous response to fetch the next page.

    textSearch?: string

    Full-text search query. Supports boolean operators:

    • "kick & drum" - matches both keywords
    • "guitar & (jazz | funk)" - guitar with jazz or funk
    • "!bass & guitar" - guitar but not bass

    Settings

    Member Visibility

    On This Page

    Properties