# gebo-performatives

> A speech act module for the gebo agent

Latest version **0.0.12** (published 2015-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install gebo-performatives
pnpm add gebo-performatives
yarn add gebo-performatives
bun add gebo-performatives
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.12 |
| Published | 2015-03-19 |
| First published | 2014-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Daniel Bidulock |
| Maintainers | raphaeldelaghetto |
| Keywords | gebo, agent, speech, acts |

## Links

- npm: https://www.npmjs.com/package/gebo-performatives
- Repository: https://github.com/RaphaelDeLaGhetto/gebo-performatives
- Issues: https://github.com/RaphaelDeLaGhetto/gebo-performatives/issues
- npm.io page: https://npm.io/package/gebo-performatives

## Dependencies (1)

- [mime](https://npm.io/package/mime.md) ^1.2.11

## Recent versions

- 0.0.12 (latest) — 2015-03-19
- 0.0.11 — 2015-01-13
- 0.0.10 — 2014-09-12
- 0.0.9 — 2014-05-13
- 0.0.8 — 2014-05-13
- 0.0.7 — 2014-05-13
- 0.0.6 — 2014-05-12
- 0.0.5 — 2014-05-12
- 0.0.4 — 2014-05-12
- 0.0.3 — 2014-05-09
- 0.0.2 — 2014-05-09
- 0.0.1 — 2014-05-09
- 0.0.0 — 2014-05-08

## README

gebo-performatives
==================

A speech act module for the gebo agent

# Install

```
npm install gebo-performatives
```

# Sample script

```
/**
 * This package takes care of all the tricky details
 * that come with POSTing a file
 */
var performatives = require('gebo-performatives');

/**
 * The message object defines the request you are making
 * of the gebo agent.
 *
 * All of the fields shown are required.
 */
var message = {

    // The client's unique ID (always an email address)
    sender: 'someguy@example.com',

    // You are _requesting_ that the gebo agent perform an action
    performative: 'request',

    // Some action the gebo agent is able to perform
    action: 'someAction',

    // The content field is where all the details secondary to
    // issuing the performative itself are passed to the gebo agent
    content: {

        // For example, maybe the gebo agent monitors the health of your cat
        status: 'Breath smells like cat food'
    },

    // The address where the agent resides 
    gebo: 'https://example.com',

    // The unique token that determines whether access
    // can be granted to the agent making the request
    access_token: 'SomeRandomlyAssignedAccessToken123',

    // Maybe you want to send a file... (only one at a time, I'm afraid)
    files: {

        // This is the single file you may pass to the gebo agent
        picture: {

            // File path
            path: '/full/path/to/mittens.jpg',
          }
      },
  };
 
console.log('Requesting agent action:', message);

/**
 * The request function sends the message to the address 
 * specified in the gebo property
 */
performatives.request(message, function(err, results) {
      if (err) {
        console.log(err);
      }
      else {
        console.log(JSON.stringify(JSON.parse(results), null, 4));
      }
  });
```

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