Skip to content
This repository has been archived by the owner on Aug 8, 2024. It is now read-only.

Add setAirplaneMode action #5

Merged
merged 2 commits into from
Nov 16, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions __tests__/actions/setAirplaneMode.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { setAirplaneMode } from '../../src/actions';

describe('setAirplaneMode function', () => {

it('is a function', () => {
expect(typeof setAirplaneMode).toBe('function');
});

it('builds a setAirplaneMode action when no value is passed', () => {
const expected = {
WFWorkflowActionIdentifier: 'is.workflow.actions.airplanemode.set',
WFWorkflowActionParameters: {
OnValue: true,
},
};
const actual = setAirplaneMode({});

expect(actual).toEqual(expected);
});

it('builds a setAirplaneMode action with given value', () => {
const value = false;
const expected = {
WFWorkflowActionIdentifier: 'is.workflow.actions.airplanemode.set',
WFWorkflowActionParameters: {
OnValue: value,
},
};
const actual = setAirplaneMode({ value });

expect(actual).toEqual(expected);
});

});
2 changes: 2 additions & 0 deletions src/actions/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import getDictionaryValue from './getDictionaryValue';
import nothing from './nothing';
import number from './number';
import runShortcut from './runShortcut';
import setAirplaneMode from './setAirplaneMode';
import setBrightness from './setBrightness';
import setLowPowerMode from './setLowPowerMode';
import setTorch from './setTorch';
Expand All @@ -32,6 +33,7 @@ export {
nothing,
number,
runShortcut,
setAirplaneMode,
setBrightness,
setLowPowerMode,
setTorch,
Expand Down
25 changes: 25 additions & 0 deletions src/actions/setAirplaneMode.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/** @module actions */

import WFWorkflowAction from '../interfaces/WF/WFWorkflowAction';

type SetAirplaneModeOptions = {
value?: boolean;
};

/**
* Set Airplane Mode Action. Sets the device's Airplane Mode to on or off.
* @param {Object} options
* @param {boolean} [options.value=true]
*/
const setLowPowerMode = (
joshfarrant marked this conversation as resolved.
Show resolved Hide resolved
{
value = true,
}: SetAirplaneModeOptions,
): WFWorkflowAction => ({
WFWorkflowActionIdentifier: 'is.workflow.actions.airplanemode.set',
WFWorkflowActionParameters: {
OnValue: value,
},
});

export default setLowPowerMode;
1 change: 1 addition & 0 deletions src/interfaces/WF/WFWorkflowActionIdentifier.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
type WFWorkflowActionIdentifier = (
'is.workflow.actions.ask'
| 'is.workflow.actions.airplanemode.set'
| 'is.workflow.actions.choosefrommenu'
| 'is.workflow.actions.comment'
| 'is.workflow.actions.conditional'
Expand Down