Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

mtasa

0.1.3 • Public • Published

Build Status Coverage Status MIT license

MTA:SA SDK for Node.js

Lightweight module to simplify integration of external apps with MTA:SA servers. Uses the standard HTTP call interface, which you can learn more about here.

Installation

npm install mtasa --save

Usage

Import the Client class:

TypeScript:

import { Client } from "mtasa";

JavaScript:

const Client = require('mtasa').Client;

Then create a new client instance and use it to make some remote calls:

// Setup a new client for local server
const mta = new Client("127.0.0.1", 22005, "root", "pass");
 
// Perform calls using async/await:
(async () => {
    try {
        // Call some procedure
        const result = await mta.resources.test_resource.testProcedure("some param");
 
        // Call a procedure (the alternative verbose API)
        const verboseCallResult = await mta.call("test_resource", "testProcedure", "some param", 1234);
    } catch (err) {
        console.error(`Ooops! Something went wrong ${err}`);
    }
})()
 
// Without async/await, plain old Promises:
mta.resources.test_resource.testProcedure()
    .then((result) => {
        console.log(result);
    })
    .catch((err) => {
        console.error(`Ooops! Something went wrong ${err}`);
    });

For more information on how to expose your MTA server APIs (like the testProcedure function from test_resource resource) over the web interface, refer to Resource Web Access wiki page.

Documentation

The source code has inline documentation, which is also included in typings (.d.ts) shipped with the module. This means that no matter if you write plain old JavaScript or TypeScript - as long as you use some decent editor with intellisense (like Visual Studio Code), you should get nice autocompletion and feedback with documentation. Just give it a try yourself - use one of the examples above, type new Client( at the very end and hit CTRL + Shift + Space if the popup didn't appear automatically already.

VSCode demo

You can also jump straight into the source code of the library and unit tests.

Project status

This library is totally usable but is perhaps still lacking some features, hence the 0.1.x version. I consider it stable for my own needs. Feel free to report bugs or feature requests here. PRs welcome too.

License

MIT

Keywords

none

Install

npm i mtasa

DownloadsWeekly Downloads

34

Version

0.1.3

License

MIT

Unpacked Size

13.6 kB

Total Files

7

Last publish

Collaborators

  • avatar