1.0.5 • Published 4 months ago

mta-connection v1.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

MtaConnection

npm license

English

MtaConnection is a client for interacting with the MTA:SA HTTP API in Node.js.

Installation

npm install mta-connection

Usage

import MtaConnection from "mta-connection";

const mta = new MtaConnection({
  host: "127.0.0.1",
  port: 22005,
  protocol: "http",
  credentials: {
    username: "admin",
    password: "password",
  },
});

async function testCall() {
  try {
    const result = await mta.api.resourceName.procedureName("param1", "param2");
    console.log(result);
  } catch (error) {
    console.error("Error:", error);
  }
}

testCall();

Configuration

OptionTypeDescriptionDefault Value
hoststringMTA:SA server address127.0.0.1
portnumberHTTP API port22005
protocol"http" \| "https"Connection protocolhttp
credentials.usernamestringAPI loginundefined
credentials.passwordstringAPI passwordundefined

API

MtaConnection automatically generates methods to call API resources:

const result = await mta.api.resourceName.procedureName(param1, param2);
  • resourceName — the name of the MTA resource.
  • procedureName — the name of the exported server function.
  • param1, param2, ... — parameters passed to the function.

Русский

MtaConnection — это клиент для взаимодействия с HTTP API MTA:SA на Node.js.

Установка

npm install mta-connection

Использование

import MtaConnection from "mta-connection";

const mta = new MtaConnection({
  host: "127.0.0.1",
  port: 22005,
  protocol: "http",
  credentials: {
    username: "admin",
    password: "password",
  },
});

async function testCall() {
  try {
    const result = await mta.api.resourceName.procedureName("param1", "param2");
    console.log(result);
  } catch (error) {
    console.error("Error:", error);
  }
}

testCall();

Конфигурация

ОпцияТипОписаниеЗначение по умолчанию
hoststringАдрес сервера MTA:SA127.0.0.1
portnumberПорт HTTP API22005
protocol"http" \| "https"Протокол соединенияhttp
credentials.usernamestringЛогин для APIundefined
credentials.passwordstringПароль для APIundefined

API

MtaConnection автоматически создаёт методы для вызова API-ресурсов:

const result = await mta.api.resourceName.procedureName(param1, param2);
  • resourceName — название MTA ресурса.
  • procedureName — название экспортированной серверной функции.
  • param1, param2, ... — параметры, передаваемые в функцию.

License / Лицензия

This project is licensed under the MIT license. / Этот проект распространяется под лицензией MIT.

1.0.5

4 months ago

1.0.2

4 months ago

1.0.1

4 months ago

1.0.0

4 months ago