README

alfy-test

Test your Alfy workflows

Install

$ npm install alfy-test

Usage

import test from 'ava';
import alfyTest from 'alfy-test';

test('foo', async t => {
    const alfy = alfyTest();

    const result = await alfy('workflow input');

    t.deepEqual(result, [
        {
            title: 'foo',
            subtitle: 'bar'
        }
    ]);
});

API

alfyTest(options?)

Returns an alfy instance.

options

Type: object

userConfig

Type: object

A JSON object representing the user configuration.

version

Type: string
Default: '3.0.3'

Alfred version.

theme

Type: string
Default: 'theme.urlimport.153A3C58-B2D9-4F08-B342-B0BF7F6E8DE9'

Alfred theme.

theme_background

Type: string
Default: 'rgba(252,254,255,0.85)'

Background color.

theme_selection

Type: string
Default: 'rgba(255,255,255,0.26)'

Background color of a selected item.

theme_subtext

Type: string
Default: '1'

Show the item subtitle.

alfy(...input)

Returns a Promise that returns the items of the workflow.

input

Type: string[]

Workflow input.

.config

The alfy config instance.

.cache

The alfy cache instance.

Examples

alfred-ng2 - Search for Angular 2 API references

Usage no npm install needed!