@ptkl/sdk - v1.7.1
    Preparing search index...

    Class default

    Base client for the platform API Classes that extend PlatformBaseClient have intentins of only working in platform context

    PlatformBaseClient

    The axios instance to use for the client

    // if sdk is used in the forge app that is running in the platform context
    const utils = new ComponentUtils()
    // this won't work outside of platform context because client needs authtorization to communicate with the API.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client env host token

    Methods

    idl idlValidate resourceResolver setClient

    Constructors

    • Parameters

      • Optionaloptions: { env?: string; host?: string; token?: string }

      Returns default

    Properties

    client: AxiosInstance
    env: null | string = null
    host: null | string = null
    token: null | string = null

    Methods

    • Returns all IDL definitions for the current project. Used by ptkl generate-types to emit typed .d.ts augmentations.

      Returns Promise<{ data: IDLAllResponse }>

    • Validates a value against an IDL — either by ref or with an inline IDL object. Returns { data: { valid: true } } on success or { data: { valid: false, errors: [...] } } on validation failure. Throws on HTTP errors (4xx/5xx).

      Parameters

      Returns Promise<{ data: IDLValidateResponse }>

    • Parameters

      • prn: string
      • Optionalformat: string

      Returns Promise<AxiosResponse<any, any>>

    • Parameters

      • client: AxiosInstance

      Returns default

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods