Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@sap/mta-lib

sap_extncrepos690.6kSEE LICENSE IN LICENSE1.7.4TypeScript support: included

Library for creating, reading and modifying multi-target application descriptor files

readme

@sap/mta-lib

Javascript wrapper library for creating, reading and modifying multi-target application development descriptor files.

Requirements

This library uses Cloud MTA version 1.0.0. It is not required to install it to use the library, but if it is found in the path in the correct version, it will be used. Otherwise, this library will download it.

Sample usage

Adding a new module:

import { Mta, mta } from "@sap/mta-lib";
import * as path from "path";

let projectPath; // = ...

const mtaObj = new Mta(projectPath);

const mtaModule: mta.Module = {
  name: this.appName,
  type: "my-type",
  path: path.relative(this.appOptions.projectPath, this.appPath),
  parameters: {
    "disk-quota": "DISK_QUOTA",
    memory: "MEMORY",
  },
  requires: [
    {
      name: this.appOptions.projectName + "suffix",
    },
  ],
};

await mtaObj.addModule(mtaModule);

// ...

try {
  await mtaObj.save();
} catch (e) {
  console.log(e);
}

Packaging with webpack

To use this library from an application packaged with webpack, you have to follow the instructions for packaging the mta-local package.