# Opciones de NEWACTION y objeto de la acción

> Configura una acción de Total.js 5: entradas, permisos, validación, respuesta y propiedades disponibles durante su ejecución.

Framework: total5
Product: Total.js 5 (total5@0.0.19)
Language: es
Content-SHA256: 625ada47b759163478adc0f34f469e5c8049ef36df44d7288e82d44646602d8b
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: total5-installed@total5@0.0.19
Review: not-recorded

`NEWACTION(name, options)` declara una acción. `name` es su id (`Users/insert`): las rutas la usan con `--> *Users/insert` y tu código con `ACTION('Users/insert', payload)`.

## Opciones

| Opción | Valor | Qué hace |
|---|---|---|
| `name` | texto | Una descripción de la acción; también está disponible como `$.name`. |
| `action` | `function($, model)` | El código de la acción. `model` es la entrada validada. |
| `input` | texto | Los campos del cuerpo, como `name:Type` separados por comas; un `*` antes del nombre lo hace obligatorio. Consulta la página de tipos de entrada. |
| `output` | texto | Los campos de la respuesta; los campos que no se listan se eliminan. |
| `params` | texto | Los segmentos `{name}` de la ruta, validados como `input`. |
| `query` | texto | La cadena de consulta, validada como `input`. |
| `partial` | `true` | Solo los campos que se enviaron llegan a la acción. Úsalo para `PATCH`. |
| `user` | `true` o `false` | `true` responde 401 cuando no hay un usuario autenticado; `false` acepta solo peticiones anónimas. |
| `permissions` | texto o array | `'read,write'`: el usuario necesita uno de ellos (o ser superadministrador). |
| `route` | texto | Declara aquí la ruta de la acción: `'GET /products/'`, o `true` para una ruta `API`. |
| `middleware` | texto | Nombres de middleware que se ejecutan antes de la acción, separados por espacios o comas. |
| `timeout` | milisegundos | Si la acción no responde a tiempo, la petición falla con el error `Timeout.`. |
| `cache` | `true` o un objeto | Guarda el resultado de una acción con `CACHE`. |
| `config` | objeto | Valores que la acción lee desde `$.config`. |
| `audit` | text | Registra un evento automático al completar la acción correctamente; la receta específica comprueba sus límites. [action-audit](/en/total5/action-audit/) |
| `csrf`, `encrypt`, `compress`, `publish` | - | [action-transport-boundaries](/en/total5/action-transport-boundaries/) |
| `sa`, `su` | true | [action-hooks-and-admin](/en/total5/action-hooks-and-admin/) |
| `oninput`, `onoutput` | function | [action-hooks-and-admin](/en/total5/action-hooks-and-admin/) |
| `extend` | path | [action-hooks-and-admin](/en/total5/action-hooks-and-admin/) |

## El objeto `$` de una acción

| Miembro | Qué es |
|---|---|
| `$.query`, `$.params` | La cadena de consulta y los segmentos de la ruta, validados. |
| `$.payload` | La entrada validada; es el mismo objeto que el segundo argumento de `action`. |
| `$.user` | El usuario autenticado. |
| `$.config` | La opción `config`. |
| `$.name`, `$.id` | La opción `name` y el id de la acción. |
| `$.controller` | El `$` de la ruta cuando la acción se llamó desde una ruta, así que `$.controller.body` es el cuerpo sin procesar. No existe cuando la acción se llama con `ACTION()`. |
| `$.callback(value)` | Responde con un valor; se filtra con `output`. Sin argumentos devuelve una función `(err, response)`. |
| `$.success(value)` | Responde `{ success: true }`. |
| `$.invalid(error)` | Responde con un error: un texto, un código de estado o un `ErrorBuilder`. |
| `$.done(arg)`, `$.successful(fn)` | Devuelven callbacks para funciones que informan de un error como primer argumento. |
| `$.cookie(name, value, expiration)` | Lee o escribe una cookie de la petición. |
| `$.redirect(url)` | Redirige la petición. |
| `$.output(name)` | Elige cómo responde una ruta: `json`, `html`, `xml`, `text`, `redirect`, `binary`, `jsonstring`, `empty` o `file`. |
| `$.unauthorized(...permissions)` | Responde 401 y devuelve `true` cuando el usuario no tiene ninguno de los permisos. |
| `$.action(name, payload)` | Ejecuta otra acción con la misma petición. |
| `$.hostname(path)` | La dirección de este servidor. |

```js definitions/options.js
MIDDLEWARE('tag', function($, next) {
	$.response.headers['x-tag'] = 'on';
	next();
});

var counter = { cached: 0 };
MAIN.counter = counter;

NEWACTION('Options/named', {
	name: 'The name',
	config: { limit: 3 },
	action: function($) {
		$.callback({ name: $.name, id: $.id, limit: $.config.limit });
	}
});

NEWACTION('Options/guarded', {
	name: 'Needs a user',
	user: true,
	permissions: 'read',
	action: function($) {
		$.success();
	}
});

NEWACTION('Options/slow', {
	name: 'Never answers',
	timeout: 300,
	action: function($) {}
});

NEWACTION('Options/cached', {
	name: 'The cache option',
	query: 'page:Number',
	cache: { expire: '1 minute', query: 'page' },
	action: function($) {
		counter.cached++;
		$.callback({ page: $.query.page, runs: counter.cached });
	}
});

NEWACTION('Options/routed', {
	name: 'Declares its own route',
	route: 'GET /routed/ #tag',
	action: function($) {
		$.callback({ routed: true });
	}
});

NEWACTION('Options/output', {
	name: 'Chooses how to answer',
	action: function($) {
		$.output('plain');
		$.callback('plain text');
	}
});

AUTH(function($) {
	if ($.headers['x-user'])
		$.success({ id: '1', permissions: $.headers['x-user'].split(',') });
	else
		$.invalid();
});
```

```js controllers/options.js
exports.install = function() {
	ROUTE('GET /named/ --> *Options/named');
	ROUTE('GET /guarded/ --> *Options/guarded');
	ROUTE('GET /slow/ --> *Options/slow');
	ROUTE('GET /cached/ --> *Options/cached');
	ROUTE('GET /output/ --> *Options/output');
};
```