basyx-typescript-sdk
TypeScript icon, indicating that this package has built-in type declarations

0.2.2 • Public • Published

GitHub Actions Workflow Status NPM Downloads NPM Version GitHub License

basyx-typescript-sdk

BaSyx TypeScript SDK for developing applications and components for the Asset Administration Shell (AAS)

Features

Clients for the AAS API components:

  • AAS Repository
  • Submodel Repository (coming soon)
  • Concept Description Repository (coming soon)
  • AAS Registry (coming soon)
  • Submodel Registry (coming soon)
  • AAS Discovery Service (coming soon)
  • AASX File Service (coming soon)

Utility functions for working with AAS data:

  • Coming soon

Installation

npm install basyx-typescript-sdk
# or
yarn add basyx-typescript-sdk

See https://www.npmjs.com/package/basyx-typescript-sdk


[!IMPORTANT] Make sure to install @aas-core-works/aas-core3.0-typescript in your project:

npm install @aas-core-works/aas-core3.0-typescript
# or
yarn add @aas-core-works/aas-core3.0-typescript

Usage

import { AasRepositoryClient } from 'basyx-typescript-sdk';

async function getAllShells() {
    const baseURL = 'http://localhost:8081';
    const client = new AasRepositoryClient();

    try {
        const response = await client.getAllAssetAdministrationShells({ baseUrl: baseURL });
        console.log('Asset Administration Shells fetched successfully:', response);
        // You can now use the response as needed
    } catch (error) {
        console.error('Error fetching Asset Administration Shells:', error);
    }
}

getAllShells();

/basyx-typescript-sdk/

    Package Sidebar

    Install

    npm i basyx-typescript-sdk

    Weekly Downloads

    21

    Version

    0.2.2

    License

    MIT

    Unpacked Size

    1.18 MB

    Total Files

    40

    Last publish

    Collaborators

    • eclipse-basyx-bot