spws/src/services/lists/getListItems/batch.test.ts

SharePoint Web Services Wrapper

import CamlBuilder from "camljs";
import getListItems from "./";
import getList from "../getList";

describe("getListItems: Batch Tests", () => {
  it("Get List Items Threshold", async () => {
    // Set list name
    const listName = "Get List Items Threshold";

    // Get list for the item count
    const { data: list } = await getList(listName);

    // Send test request
    const res = await getListItems(listName, {
      fields: ["Modified", "Editor"],
      query: new CamlBuilder().Where().DateField("Modified").IsNotNull().ToString(),
      batch: true,
    });

    // The response should have all the items in the list
    expect(res.data.length).toBe(parseInt(list.ItemCount!));
  }, 45000);

  it("Get List Items 1 Item with batching", async () => {
    const listName = "Get List Items 1 Item";

    // Get list for the item count
    const { data: list } = await getList(listName);

    // Send test request
    const res = await getListItems(listName, {
      fields: ["Modified", "Editor"],
      query: new CamlBuilder().Where().DateField("Modified").IsNotNull().ToString(),
      batch: true,
    });

    // The response should have all the items in the list
    expect(res.data.length).toBe(parseInt(list.ItemCount!));
  });

  it("Get List Items 0 Item with batching", async () => {
    const listName = "Get List Items No Items";

    // Get list for the item count
    const { data: list } = await getList(listName);

    // Send test request
    const res = await getListItems(listName, {
      fields: ["Modified", "Editor"],
      query: new CamlBuilder().Where().DateField("Modified").IsNotNull().ToString(),
      batch: true,
    });

    // The response should have all the items in the list
    expect(res.data.length).toBe(parseInt(list.ItemCount!));
  });

  it("Get batch updates", async () => {
    // Set list name
    const listName = "Get List Items Threshold";

    // Get list for the item count
    const { data: list } = await getList(listName);

    // Get batches (list view threshold / 2000)
    const batchCount = Math.ceil(+list.ItemCount! / +list.MaxItemsPerThrottledOperation!);

    // Send test request
    const res = await getListItems(listName, {
      fields: ["Modified", "Editor"],
      query: new CamlBuilder().Where().DateField("Modified").IsNotNull().ToString(),
      batch: true,
      onBatchStart: (total) => expect(total).toBe(batchCount),
      onBatchStep: ({ index, total }) => {
        expect(index).toBeLessThanOrEqual(total);
        expect(total).toBe(batchCount);
      },
    });
  }, 30000);
});