parsers.md

@pnp/odata/parsers

This modules contains a set of generic parsers. These can be used or extended as needed, though it is likely in most cases the default parser will be all you need.

ODataDefaultParser

The simplest parser used to transform a Response into its JSON representation. The default parser will handle errors in a consistent manner throwing an HttpRequestError instance. This class extends Error and adds the response, status, and statusText properties. The response object is unread. You can use this custom error as shown below to gather more information about what went wrong in the request.

import { sp } from "@pnp/sp";
import { JSONParser } from "@pnp/odata";

try {

    const parser = new JSONParser();

    // this always throws a 404 error
    await sp.web.getList("doesn't exist").get(parser);

} catch (e) {

    // we can check for the property "isHttpRequestError" to see if this is an instance of our class
    // this gets by all the many limitations of subclassing Error and type detection in JavaScript
    if (e.hasOwnProperty("isHttpRequestError")) {

        console.log("e is HttpRequestError");

        // now we can access the various properties and make use of the response object.
        // at this point the body is unread
        console.log(`status: ${e.status}`);
        console.log(`statusText: ${e.statusText}`);

        const json = await e.response.clone().json();
        console.log(JSON.stringify(json));
        const text = await e.response.clone().text();
        console.log(text);
        const headers = e.response.headers;
    }

    console.error(e);
}

TextParser

Specialized parser used to parse the response using the .text() method with no other processing. Used primarily for files.

BlobParser

Specialized parser used to parse the response using the .blob() method with no other processing. Used primarily for files.

JSONParser

Specialized parser used to parse the response using the .json() method with no other processing. Used primarily for files.

BufferParser

Specialized parser used to parse the response using the .arrayBuffer() [node] for .buffer() [browser] method with no other processing. Used primarily for files.

LambdaParser

Allows you to pass in any handler function you want, called if the request does not result in an error that ransforms the raw, unread request into the result type.

import { LambdaParser } from "@pnp/odata";
import { sp } from "@pnp/sp";

// here a simple parser duplicating the functionality of the JSONParser
const parser = new LambdaParser((r: Response) => r.json());

const webDataJson = await sp.web.get(parser);

console.log(webDataJson);