Protocol Launcher

English

简体中文

English

简体中文

Appearance

Tim ​

Tim is a macOS time tracker. Protocol Launcher allows you to generate Tim deep links.

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 ​

Tim's official help page documents exactly these URL forms: tim://, tim://[id], tim://[id]?action=start&notes=My%20Notes, tim://?action=stop, tim://create?type=[task|group]&title=My%20Title&notes=My%20Notes, and tim://x-callback-url/getCurrentUrl?x-success=https://www.apple.com.

createTask() and createGroup() expose only the documented task/group type plus title and notes. The official page does not name any other query fields, so this module does not add them.

Open Tim ​

On-Demand
ts
import { open } from 'protocol-launcher/tim'

const url = open()
Open Tim

Open Task Or Group ​

On-Demand
ts
import { openTaskOrGroup } from 'protocol-launcher/tim'

const url = openTaskOrGroup({
  id: 'D43FA035-6406-495D-9ADD-46721986040F',
})
Open Task Or Group

Start Task ​

On-Demand
ts
import { startTask } from 'protocol-launcher/tim'

const url = startTask({
  id: 'D43FA035-6406-495D-9ADD-46721986040F',
  notes: 'My Notes',
})

Stop Timer ​

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

const url = stopTimer()

Create Task ​

On-Demand
ts
import { createTask } from 'protocol-launcher/tim'

const url = createTask({
  title: 'My Title',
  notes: 'My Notes',
})

Create Group ​

On-Demand
ts
import { createGroup } from 'protocol-launcher/tim'

const url = createGroup({
  title: 'My Title',
  notes: 'My Notes',
})

Get Current URL ​

On-Demand
ts
import { getCurrentUrl } from 'protocol-launcher/tim'

const url = getCurrentUrl({
  xSuccess: 'https://www.apple.com',
})

Generated URLs ​

ts
open()
// => 'tim://'

openTaskOrGroup({
  id: 'D43FA035-6406-495D-9ADD-46721986040F',
})
// => 'tim://D43FA035-6406-495D-9ADD-46721986040F'

startTask({
  id: 'D43FA035-6406-495D-9ADD-46721986040F',
  notes: 'My Notes',
})
// => 'tim://D43FA035-6406-495D-9ADD-46721986040F?action=start&notes=My%20Notes'

stopTimer()
// => 'tim://?action=stop'

createTask({
  title: 'My Title',
  notes: 'My Notes',
})
// => 'tim://create?type=task&title=My%20Title&notes=My%20Notes'

createGroup({
  title: 'My Title',
  notes: 'My Notes',
})
// => 'tim://create?type=group&title=My%20Title&notes=My%20Notes'

getCurrentUrl({
  xSuccess: 'https://www.apple.com',
})
// => 'tim://x-callback-url/getCurrentUrl?x-success=https://www.apple.com'

Official Documentation ​