# yajsapi

> NodeJS API for Next Golem

Latest version **0.7.1** (published 2023-07-31) · LGPL-3.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install yajsapi
pnpm add yajsapi
yarn add yajsapi
bun add yajsapi
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.7.1 |
| Published | 2023-07-31 |
| First published | 2020-10-12 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16.0.0 |
| Dependencies | 10 |
| Unpacked size | 829.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | GolemFactory |
| Maintainers | grisha87, braunmann, mgordel, prekucki, mfrancis, theshadeofblue, mdt. |

## Links

- npm: https://www.npmjs.com/package/yajsapi
- Repository: https://github.com/golemfactory/yajsapi
- Homepage: https://github.com/golemfactory/yajsapi#readme
- Issues: https://github.com/golemfactory/yajsapi/issues
- npm.io page: https://npm.io/package/yajsapi

## Dependencies (10)

- [tmp](https://npm.io/package/tmp.md) ^0.2.1
- [pino](https://npm.io/package/pino.md) ^8.11.0
- [axios](https://npm.io/package/axios.md) ^1.1.3
- [ip-num](https://npm.io/package/ip-num.md) ^1.4.1
- [bottleneck](https://npm.io/package/bottleneck.md) ^2.19.5
- [collect.js](https://npm.io/package/collect.js.md) ^4.34.3
- [eventsource](https://npm.io/package/eventsource.md) ^2.0.2
- [pino-pretty](https://npm.io/package/pino-pretty.md) ^10.0.1
- [ya-ts-client](https://npm.io/package/ya-ts-client.md) ^0.5.3
- [@rauschma/stringio](https://npm.io/package/@rauschma/stringio.md) ^1.4.0

## Recent versions

- 0.7.1 (latest) — 2023-07-31
- 0.7.0 — 2023-07-18
- 0.7.0-alpha.2 — 2023-06-16
- 0.7.0-alpha.1 — 2023-06-01
- 0.7.0-alpha.0 — 2023-03-16
- 0.6.1 — 2022-12-06
- 0.6.0 — 2021-12-08
- 0.5.1 — 2021-10-11
- 0.5.0 — 2021-10-11
- 0.4.3 — 2021-08-13
- 0.4.2 — 2021-07-08
- 0.4.1 — 2021-06-24
- 0.4.0 — 2021-06-16
- 0.3.5 — 2021-05-20
- 0.3.4 — 2021-05-06
- … 10 more at https://npm.io/package/yajsapi/versions

## README

# Golem JavaScript API

![GitHub](https://img.shields.io/github/license/golemfactory/yajsapi)
![npm](https://img.shields.io/npm/v/yajsapi) 
![node-current](https://img.shields.io/node/v/yajsapi)
![npm type definitions](https://img.shields.io/npm/types/yajsapi)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/golemfactory/yajsapi/goth.yml)
[![GitHub issues](https://img.shields.io/github/issues/golemfactory/yajsapi)](https://github.com/golemfactory/yajsapi/issues)
![Discord](https://img.shields.io/discord/684703559954333727?style=flat&logo=discord)

## What's Golem and yajsapi?

**[The Golem Network](https://golem.network)** fosters a global group of creators building ambitious software solutions that will shape the technological landscape of future generations by accessing computing resources across the platform. Golem Network is an accessible, reliable, open access and censorship-resistant protocol, democratizing access to digital resources and connecting users through a flexible, open-source platform.

**Yajsapi** is the JavaScript API that allows developers to connect to their Golem nodes and manage their distributed, computational loads through Golem Network.

## Golem application development

For a detailed introduction to using Golem and yajsapi to run your tasks on Golem [please consult our quickstart section](https://docs.golem.network/creators/javascript/quickstart/).

### Installation

`yajsapi` is available as a [NPM package](https://www.npmjs.com/package/yajsapi/).

You can install it through `npm`:

```bash
npm install yajsapi
```
or by `yarn`:

```bash
yarn add yajsapi
```

### Building

To build a library available to the nodejs environment:

```bash
npm run build
# or
yarn build
```

This will generate production code in the `dist/` directory ready to be used in your nodejs or browser applications.


### Usage

Hello World

```javascript
import { TaskExecutor } from "yajsapi";

(async function main() {
  const executor = await TaskExecutor.create("9a3b5d67b0b27746283cb5f287c13eab1beaa12d92a9f536b747c7ae");
  await executor.run(async (ctx) => console.log(await ctx.run("echo 'Hello World'")).stdout);
  await executor.end();
})();
```

#### Node.js context
![hello_nodejs](https://user-images.githubusercontent.com/26308335/224720742-1ca115e2-e207-41a7-9537-ffa4ece11406.gif)

#### Web Browser context
![hello_web](https://user-images.githubusercontent.com/26308335/217530424-a1dd4487-f95f-43e6-a91b-7106b6f30802.gif)

For more detailed usage examples and tutorials, see the [Java Script API section of the Golem Network Docs](https://docs.golem.network/creators/javascript/)

### Testing

### Running unit tests

To run unit tests, you can simply execute the command:

```bash
npm run test:unit
# or
yarn test:unit
```

### Running integration tests

Both test cases for the nodejs environment and the browser (cypress) require preparation of a test environment of the golem network with providers and all the necessary infrastructure. [Goth](https://github.com/golemfactory/goth) framework is used for this purpose.

To enable integration testing, you need to ensure that `python -m goth` is executable. Therefore, you must first install [Goth](https://github.com/golemfactory/goth) according to the instructions described in the readme of the project.

#### Nodejs

```bash
npm run test:integration
# or
yarn test:integration
```

#### Cypress

```bash
npm run test:cypress
# or
yarn test:cypress
```

### Contributing

It is recommended to run unit tests and static code analysis before committing changes.

```bash
yarn lint
# and
yarn format
```

## See also

* [Golem](https://golem.network), a global, open-source, decentralized supercomputer that anyone can access.
* Learn what you need to know to set-up your Golem requestor node:
    * [Requestor development: a quick primer](https://handbook.golem.network/requestor-tutorials/flash-tutorial-of-requestor-development)
    * [Quick start](https://docs.golem.network/creators/javascript/quickstart/)
* Have a look at the most important concepts behind any Golem application: [Golem application fundamentals](https://handbook.golem.network/requestor-tutorials/golem-application-fundamentals)
* Learn about preparing your own Docker-like images for the [VM runtime](https://handbook.golem.network/requestor-tutorials/vm-runtime)
* Write your own app with [JavaScript API](https://docs.golem.network/creators/javascript/high-level/task-model/)

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