Snippets

Qué son los Snippets

Los Snippets son fragmentos reutilizables de JavaScript que defines una vez e incorporas a los scripts de tus comprobaciones con require(). En lugar de pegar la misma función de ayuda, lógica de firma de tokens o código de preparación en cada comprobación, lo guardas como snippet y lo requieres por su nombre: lo actualizas en un solo sitio y todas las comprobaciones que lo usan adoptan el cambio.

Un snippet es simplemente un pequeño módulo de JavaScript. Todo lo que exporte con module.exports queda disponible allí donde lo requieras:

require('./snippets/name');

Los snippets están asociados a tu equipo, de modo que todos los miembros del equipo pueden requerir los mismos ayudantes desde sus comprobaciones.

Gestionar Snippets

Abre la página de Snippets para crear, editar y eliminar snippets.

Crear un Snippet

1. Haz clic en New Snippet.
2. Introduce un Nombre de snippet: es el nombre que requerirás en tus scripts (por ejemplo auth o format-date). Los nombres solo pueden contener letras, números, guiones y guiones bajos.
3. Escribe tu JavaScript en el editor. Exporta lo que quieras reutilizar con module.exports.
4. Haz clic en Save Snippet.

Cada nombre de snippet debe ser único dentro de tu equipo.

Editar o eliminar un Snippet

Usa las acciones de fila en la página de Snippets para actualizar el código de un snippet o eliminarlo. Si un snippet está siendo utilizado por una o más comprobaciones, LoadFocus te avisa antes de guardar o eliminar, porque el cambio afecta a todas las comprobaciones que lo requieren. Una actualización se aplica en la siguiente ejecución de cualquier comprobación que lo use.

Usar un Snippet en el script de una comprobación

Requiere un snippet por su nombre desde la ruta ./snippets/ dentro del script de una comprobación:

const auth = require('./snippets/auth');

El valor que obtienes es exactamente lo que el snippet exporta.

Ejemplo

Crea un snippet llamado auth que construya una cabecera Authorization:

// snippet: auth
module.exports = function bearer(token) {
  return { Authorization: 'Bearer ' + token };
};

Luego úsalo desde el script de una comprobación:

const bearer = require('./snippets/auth');

const headers = bearer(process.env.API_TOKEN);
// pasa `headers` a tu petición

Puedes guardar cualquier lógica reutilizable en un snippet —firma de peticiones, constructores de payload, ayudantes de fechas y cadenas, o aserciones compartidas— y requerirlo desde tantas comprobaciones como necesites.

Snippets frente a Variables y Secretos

Usa Snippets para código reutilizable: funciones de ayuda y lógica compartida entre los scripts de las comprobaciones.

Usa Variables para valores reutilizables como URLs base e identificadores de cuenta, referenciados con {{VARIABLE_NAME}}.

Usa Secretos para valores sensibles como tokens de API y contraseñas. Los secretos son de solo escritura en la interfaz y se referencian con {{SECRET_NAME}}.

Consejo: guarda los valores sensibles en Secretos, no incrustados en un snippet. Pásalos a las funciones de tu snippet en tiempo de ejecución.

Guías relacionadas

• Cómo crear una nueva comprobación de API
• Variables
• Comprobaciones de API multipaso