@4c/todos-api 中文文档教程

Question

todos-api

待办事项列表服务器在内存中的假后端 用于

Usage

import api from '@4c/todos-api';

await api.getTodos();

Interfaces

Todo

interface Todo {
  id: UuidString;
  title: string;
  completed: boolean;
  labels: Label[];
  dueDate: ISODateString | null;
  completedAt: ISODateString | null;
}

TodoInput

修补、更新或创建 Todo 的“部分”Todo

interface TodoInput {
  id?: UuidString;
  title: string;
  completed?: boolean = false;
  labels?: Label[];
  dueDate?: ISODateString | null;
  completedAt?: ISODateString | null;
}

Label

export interface Label {
  id: UuidString;
  title: string;
  color: string | null;
}

LabelInput

一个“部分”Label 用于修补、更新或创建 Label

interface LabelInput {
  title: string;
  color?: string;
}

API Documentation

所有方法都返回一个 Promise 并在几百毫秒的模拟延迟后解决。

api.getTodo(todoId: UuidString): Promise<Todo | null>

返回单个 Todo 对象或 null；

const myTodo = await api.getTodo('25ba9d67-3741-4513-895e-06f33ef6a509');

api.getTodos(options?: { filter: Filter<Todo> }): Promise<Todo[]>

返回一个 Todo 的数组，该数组由提供的过滤器选择性地过滤（请参阅过滤文档部分）；

const allTodos = await api.getTodos();

const completedTodos = await api.getTodos({
  filter: { completed: { $eq: true } },
});

api.saveTodo(todoInput: TodoInput): Promise<Todo>

更新或创建新的待办事项，具体取决于输入是否为id。 更新 类似于 PATCH，这意味着输入被合并到现有的待办事项中。

const newTodo = await api.saveTodo({ title: 'My todo' });

const updatedTodo = await api.saveTodo({
  ...newTodo,
  completed: true,
});

api.getLabel(labelId: UuidString): Promise<Label | null>

返回单个 Label 对象或 null；

const myLabel = await api.getLabel('25ba9d67-3741-4513-895e-06f33ef6a509');

api.getLabels(options?: { filter: Filter<Label> } ): Promise<Label[]>

返回一个 Label 的数组，该数组可以由提供的过滤器选择性地过滤（参见：下面）；

const allLabels = await api.getLabels();

const redLabels = await api.getLabels({
  filter: { color: { $eq: '#ff0000' } },
});

api.saveLabel(labelInput: LabelInput): Promise<label>

更新或创建新标签，具体取决于输入是否为id。 更新 类似于 PATCH，这意味着输入被合并到现有标签中。

const newlabel = await api.savelabel({ title: 'My label' });

const updatedlabel = await api.savelabel({
  ...newlabel,
  color: '#ff0000',
});

Filtering

为返回数组的 API 方法实现基本过滤。 过滤器 object 允许通过一个小的过滤任何顶级对象属性 运算符集。 下面是过滤器对象的人为示例：

const filter = {
  name: { $eq: 'John' },
  age: { $gte: 24, $lt: 30 },
};

如果我们将该过滤器应用于以下列表：

const people = [
  { name: 'John', age: 18 },
  { name: 'Jane', age: 32 },
  { name: 'John', age: 28 },
  { name: 'John', age: 45 },
];

结果将是：[{ name: 'John', age: 28 }]

Filter Operators

• $eq: returns for properties that are strictly equal (===) to the value. This is case sensitive
• $neq: returns for properties that are strictly NOT equal (!==) to the value. This is case sensitive
• $lt: "less than", returns if the value is < e.g. 4 < 5
• $lte: "less than or equal to", returns if the value is <= e.g. 5 <= 5
• $gt: "greater than", returns if the value is > e.g. 5 > 6
• $gte: "greater than or equal to", returns if the value is >= e.g. 5 >= 5