@pega/pcore-pconnect-typedefs

Summary

This package provide typedefs for PCore and PConnect.

Refer : https://docs.pega.com/bundle/pcore-pconnect/page/pcore-pconnect-public-apis/api/using-pcore-pconnect-public-apis.html

Installation

npm install --save-dev @pega/pcore-pconnect-typedefs@3.2.0-rev-2

Usage

In JavaScript project

Point to @pega/pcore-pconnect-typeDefs in <project-root>/jsconfig.json

{
  "exclude": [],
  "compilerOptions": {
    "typeRoots": ["node_modules/@types", "node_modules/@pega"],
    "baseUrl": "./"
  }
}

Usage for PCore APIs

PCore.getCascadeManager().registerFields();

Usage for PConnect API, Since getPConnect will be a prop inside the components and it'll be scoped with the component itself.

const { getPConnect } = props;

/** @type {PConnect} */
const pConn = getPConnect();

In TypeScript project

Point to @pega/pcore-pconnect-typeDefs in <project-root>/tsconfig.json

{
  "exclude": [],
  "compilerOptions": {
    "typeRoots": ["node_modules/@types", "node_modules/@pega"],
    "baseUrl": "./"
  }
}

Usage for PCore APIs

PCore.getCascadeManager().registerFields();

Usage for PConnect API, Since getPConnect will be a prop inside the components and it'll be scoped with the component itself.

const { getPConnect } = props;
const pconn: typeof PConnect = getPConnect();

Additional Details

Last updated: Wed, 11 Oct 2023 16:34:20 GMT

Global values: PCore, PConnect, getPConnect

Credits

These definitions were written by pega.

Keywords

Pega PCore Pega Platform