Function buildFilterQueryBatches

  • buildFilterQueryBatches(fieldName, keys, limit?): (Required<Pick<PaginatedListQueryOptions, "filter" | "top">> | undefined)[]

  • Build filter query that can be used to make batch of request easily based on the passed field name and ids

    Parameters

    • fieldName: string

      field name want to filter

    • keys: string[]

      array of variable

    • limit: number = 50

      limit of each batch

    Returns (Required<Pick<PaginatedListQueryOptions, "filter" | "top">> | undefined)[]

    batch of filter query

    Example

    buildBatchFilterQuery('id', ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10'], 3)
    // [
    //   { filter: "id in ['1','2','3']", top: 3 },
    //   { filter: "id in ['4','5','6']", top: 3 },
    //   { filter: "id in ['7','8','9']", top: 3 },
    //   { filter: "id in ['10']", top: 1 }
    // ]

    Example

    buildBatchFilterQuery('user.name', ['owen', 'jones', 'donald'], 2)
    // [
    //   { filter: "user.name in ['owen','jones']", top: 2 },
    //   { filter: "user.name in ['donald']", top: 1 }
    // ]

Settings

Member Visibility

Theme

Generated using TypeDoc