TourKit
@tour-kit/checklistsUtilities

createChecklist & createTask

createChecklist factory: build validated checklist configurations with type-safe task definitions and dependency declarations

createChecklist & createTask

Type-safe factory functions for creating checklists and tasks with validation.

createChecklist

import { createChecklist } from '@tour-kit/checklists';

const checklist = createChecklist({
  id: 'onboarding',
  title: 'Get Started',
  tasks: [
    { id: 'step1', title: 'First step' },
    { id: 'step2', title: 'Second step' },
  ],
});

These factories validate your configuration at creation time and provide better TypeScript inference.

createTask

import { createTask } from '@tour-kit/checklists';

const task = createTask({
  id: 'verify-email',
  title: 'Verify your email',
  description: 'Check your inbox',
  dependsOn: ['create-account'],
  action: {
    type: 'navigate',
    url: '/verify',
  },
});

Benefits

  • Type safety: Full TypeScript support
  • Validation: Catches errors early
  • IntelliSense: Better autocomplete
  • Reusability: Share task configs

Utilities

Checklist utility functions: create type-safe configs, resolve dependencies, and calculate progress with pure functions

Progress Utilities

Progress calculation utilities: compute completion percentages, remaining task counts, and estimated time to finish values

On this page

createChecklist & createTaskcreateChecklistcreateTaskBenefitsRelated