# faas-sdk-nodejs-ts

> faas-sdk-nodejs for writing Node.js functions

Latest version **1.0.0** (published 2022-06-09) · 0 weekly downloads

## Install

```sh
npm install faas-sdk-nodejs-ts
pnpm add faas-sdk-nodejs-ts
yarn add faas-sdk-nodejs-ts
bun add faas-sdk-nodejs-ts
```

Provides the command `faas-sdk-nodejs`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-06-09 |
| First published | 2022-06-09 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 13.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | SBT |
| Maintainers | cyber-x |

## Links

- npm: https://www.npmjs.com/package/faas-sdk-nodejs-ts
- Repository: https://dzo.sw.sbc.space/bitbucket-ci/scm/faas/faas-sdk-nodejs
- npm.io page: https://npm.io/package/faas-sdk-nodejs-ts

## Dependencies (4)

- [semver](https://npm.io/package/semver.md) ^7.3.5
- [express](https://npm.io/package/express.md) ^4.16.4
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^7.0.1

## Recent versions

- 1.0.0 (latest) — 2022-06-09

## README

# faas-sdk for Node.js

SDK основанный на [Express](https://expressjs.com/) для разработки функций на NodeJS, выполняемых в среде Platform V Functions.

### Quickstart:

1. Создайте `package.json`, используя команду `npm init -y`

2. Создайте файл `index.js` с функцией:
   
```js
    exports.handler = (req, res) => {
       let message = req.query.message || req.body.message || "Hello from Function";
       res.status(200).send(message);
    };
```
       
3. Установите faas-sdk-nodejs используя npm:

```sh
    npm install https://dzo.sw.sbc.space/bitbucket-ci/scm/faas/faas-sdk-nodejs.git
```
4. Добавьте скрипт `start` в файл `package.json` с нужными конфигурациями:

```
  "scripts": {
    "start": "faas-sdk-nodejs --target=handler"
  }
```
   
5. Используйте `npm start`:
   
```sh
    npm start
    ...
    Function: handler
    🚀 Function ready at http://localhost:8082
```
       
6. Отправьте запрос используя `curl`, браузер или другие инструменты:

```sh
    curl localhost:8082
    # Output: Hello from Function
```
   
## Конфигурация

Вы можете конфигурировать faas-sdk-nodejs с помощью флагов командной строки или
переменных среды:

| Флаг        | Переменные среды  |По умолчанию | Описание                                                                 |
| ------------| ------------------|-------------| -------------------------------------------------------------------------|
| `--port`    | `PORT`            |8082         | Порт для faas-sdk-nodejs.                                                |
| `--target`  | `FUNCTION_TARGET` |handler      | Имя экспортируемой функции, которая будет вызываться при запросах.       |
| `--source`  | `FUNCTION_SOURCE` |Корень папки | Путь к каталогу вашей функции.                                           |

Можете добавить в скрипт `start` необходимые команды, например: 

```
  "scripts": {
    "start": "faas-sdk-nodejs --target=your_function_name --source=./src"
  }
```
    
Также необходимо указывать путь к файлу с вашей функцией в `package.json`, например:

```
    "main": "handler.js"
```
Если это не указано, по умолчанию будет взят index.js находящийся в директории, указанной в --source или в переменной среды.

---
_Source: https://npm.io/package/faas-sdk-nodejs-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
