Things App JSON Coder

This builds a valid Things App URL to interact with Cultured Code's Things app v3.4+. Read more.

Getting Started

Installation

$ npm install things-json

Inclusion

import ThingsJSC from 'things-json';

// Or if not using babel
const ThingsJSC = require('things-json').default;

For documentation and references, see the official docs.

API

See examples in src/spec.js.

• .todo(options): object; Creates a new to-do item
• .project(options): object; Creates a new project item
• .heading(options): string or object; Creates a new heading item.
• .url(item): instance (or instances) of todo or project; converts item to an encoded URL for use. Accepts an array of items.

To-do

• title: string; title of to-do
• notes: string; text for notes (max 10K)
• when: string or date; today, tomorrow, evening, anytime, someday
• deadline: date
• tags: array of strings
• checklist: array; strings or checklistItem
• listId: string
• heading: string or object of headingItem
• completed: boolean
• canceled: boolean

const todo1 = {
    title: 'Pick up dry cleaning',
    when: 'today',
};

const todo2 = {
    title: 'Pack for vacation',
    checklist: ["Camera", "Passport"],
};

const todo1Obj = ThingsJSC.todo(todo1);
const todo2Obj = ThingsJSC.todo(todo2);

const url1 = ThingsJSC.url(todo1Obj);
const url2 = ThingsJSC.url(todo2Obj);

// Or combine URLs
const urls = ThingsJSC.url([todo1Obj, todo2Obj]);

Project

• title: string; title of to-do
• notes: string; text for notes (max 10K)
• when: string or date; today, tomorrow, evening, anytime, someday
• deadline: date
• tags: array of strings
• checklist: array; strings or checklistItem
• areaId: string
• area: string
• items: array of to-do or headingItem
• completed: boolean
• canceled: boolean

const newProject = {
    title: 'Go Shopping',
};

const project = ThingsJSC.project(newProject);
const url = ThingsJSC.url(project);

Project.addItem(item)

• item: Heading or To-Do

const newTodo = {
    title: 'Buy milk',
};
const newProject = {
    title: 'Go Shopping',
};

const project = ThingsJSC.project(newProject);
const todo = ThingsJSC.todo(newTodo);

project.addItem(todo);

const url = ThingsJSC.url(project);

checklistItem

• title: string; title of to-do
• completed: boolean
• canceled: boolean

headingItem

• title: string; title of to-do
• archived: boolean

const heading = {
    title: 'New Heading',
}

const heading = ThingsJSC.heading(heading);