src/models/Trip.ts


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

import Group from './Group';

export default interface Trip {
  /**
   * ID of the trip, used internally within the application.
   */
  id: string;

  /**
   * Name of the trip, displayed to the user.
   */
  name: string;

  /**
   * Groups the trip is split into.
   */
  groups?: Group[];

  /**
   * URL to a JSON file containing data for the trip.
   */
  url?: string;

  /**
   * Property indicating if the trip data has been already downloaded.
   */
  downloaded: boolean;

  /**
   * A group property to use while sorting groups.
   * Nested properties should be delimited with a dot.
   * Default: name.
   */
  sortProperty?: string;

  /**
   * Sort order. true = descending, false = ascending.
   */
  sortOrder?: boolean;
}