@parcnet-js/app-connector
TypeScript icon, indicating that this package has built-in type declarations

1.1.10 • Public • Published

PARCNET App Connector

The app connector is for connecting your app to PARCNET.

Getting started

Install the package:

npm install @parcnet-js/app-connector

Then connect to a PARCNET client:

import { connect } from "@parcnet-js/app-connector";

// Ensure this HTML element exists:
const element = document.getElementById("app-connector");
// The URL to the PARCNET client, e.g. Zupass
const clientUrl = "http://localhost:5173";

// Returns an API object that you can use to invoke actions
// See api_wrapper.ts for details
const api = await connect({ name: "My App Name", permissions: []}, element, clientUrl);

This will give you an API object, which can be used to invoke various APIs.

APIs

See the documentation for details of the API methods, their parameters, and results.

Readme

Keywords

none

Package Sidebar

Install

npm i @parcnet-js/app-connector

Weekly Downloads

48

Version

1.1.10

License

GPL-3.0-or-later

Unpacked Size

373 kB

Total Files

67

Last publish

Collaborators

  • rknight