Protocol Launcher

Timing ​

Timing is an automatic time tracking app for Mac. Protocol Launcher allows you to generate official URL scheme links for Timing.

Usage ​

There are two ways to use this library:

  • On-Demand import from subpaths enables tree-shaking and keeps bundles small.
  • Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand
Recommended. Optimized for production.
Full Import
Convenient. Good for quick scripts.

Notes ​

Timing's official URL scheme page says these URLs require at least Timing Expert. It also uses different schemes depending on the target: timing2helper:// for tracker app actions and timing2:// for the main Timing app.

This module exposes only the documented URL forms: startTimer, stopTimer, createTimeEntry, editTimeEntry/<time-entry-id>, and selectProjects/<project-name-or-id>.

URL Methods ​

Start Timer ​

Generate the documented URL that starts a timer in the Timing tracker app. Set startImmediately to false when you want Timing to present the dialogue first.

On-Demand
ts
import { startTimer } from 'protocol-launcher/timing'

const url = startTimer({
  title: 'Some title',
  notes: 'Some\nnotes',
  project: 'Work',
  estimatedDuration: 600,
  startDate: '2022-04-01T12:00:00Z',
  startImmediately: false,
  center: true,
})
Start Timing Timer

Stop Timer ​

Generate the documented URL that stops the currently running timer, if available. hideNotification suppresses the notification when the timer is stopped.

On-Demand
ts
import { stopTimer } from 'protocol-launcher/timing'

const url = stopTimer({
  hideNotification: true,
})

Create Time Entry ​

Generate the documented URL that creates a new time entry in the Timing tracker app.

On-Demand
ts
import { createTimeEntry } from 'protocol-launcher/timing'

const url = createTimeEntry({
  title: 'Some title',
  notes: 'Some\nnotes',
  project: 'Work',
  startDate: '2022-04-01T12:00:00Z',
  endDate: '2022-04-01T12:30:00Z',
  createImmediately: false,
  center: true,
})
Create Timing Entry

Timing documents createImmediately as available only when at least startDate, endDate, and one of title or project are provided. center and obtainFocus are only available when createImmediately is not true.

Edit Time Entry ​

Generate the documented URL that presents a dialogue to edit a time entry by ID. Timing also documents latest for editing the most recent time entry.

On-Demand
ts
import { editTimeEntry } from 'protocol-launcher/timing'

const url = editTimeEntry({
  id: 'latest',
})

Select Projects ​

Generate the documented URL that selects projects in the sidebar of the main Timing app. Omit projects to select "All Activities".

On-Demand
ts
import { selectProjects } from 'protocol-launcher/timing'

const url = selectProjects({
  projects: ['ProjectA', 'ProjectB'],
})
Select Timing Projects
On-Demand
ts
import { selectProjects } from 'protocol-launcher/timing'

const url = selectProjects()

Generated URLs ​

ts
startTimer({
  title: 'Some title',
  notes: 'Some\nnotes',
  project: 'Work',
  estimatedDuration: 600,
  startDate: '2022-04-01T12:00:00Z',
  startImmediately: false,
  center: true,
})
// => 'timing2helper://startTimer?title=Some%20title&notes=Some%0Anotes&project=Work&estimatedDuration=600&startDate=2022-04-01T12:00:00Z&startImmediately=false&center=true'

stopTimer({ hideNotification: true })
// => 'timing2helper://stopTimer?hideNotification=true'

createTimeEntry({
  title: 'Some title',
  notes: 'Some\nnotes',
  project: 'Work',
  startDate: '2022-04-01T12:00:00Z',
  endDate: '2022-04-01T12:30:00Z',
  createImmediately: false,
  center: true,
})
// => 'timing2helper://createTimeEntry?title=Some%20title&notes=Some%0Anotes&project=Work&startDate=2022-04-01T12:00:00Z&endDate=2022-04-01T12:30:00Z&createImmediately=false&center=true'

editTimeEntry({ id: 'latest' })
// => 'timing2helper://editTimeEntry/latest'

selectProjects({ projects: ['ProjectA', 'ProjectB'] })
// => 'timing2://selectProjects/ProjectA/ProjectB'

selectProjects()
// => 'timing2://selectProjects'

Official Documentation ​