less than 1 minute read

Project Creation

After creating a SPFX project using the yomen generator yo @microsoft/sharepoint, install the library using this command: npm i --save gd-sprest.


SharePoint provides the _spPageContextInfo global variable, which contains information required for the REST API request. This is only available on classic pages, and is not available on modern pages. The SPFX projects provide the Page Context information, which must be set in the library for it to work in modern pages.

Project Setup

Import the $REST or Context Information Component

import { $REST, ContextInfo } from "gd-sprest"

Set the Page Context

// or

External Reference

Edit the config/config.js file and set the externals property. Since the gd-sprest-bs library contains the gd-sprest core library, we can point both references to the same file. Now references to both libraries will reference the global $REST variable.

"externals": {
    "gd-sprest": {
        "path": "node_modules/gd-sprest-bs/dist/gd-sprest-bs.min.js",
        "globalName": "$REST"
    "gd-sprest-bs": {
        "path": "node_modules/gd-sprest-bs/dist/gd-sprest-bs.min.js",
        "globalName": "$REST"