7个高效的TypeScript工具类型，你会用了吗？

type User = {
  id: number;
  name: string;
  email: string;
}

// 接受 User 接口的键的函数
function getUserProperty(key: keyof User): string {
  const user: User = {
    id: 1,
    name: 'Mr Smith',
    email: 'mrsmith@example.com',
  };

  // 假设每个属性都可以转换为字符串
  return String(user[key]);
}

// 有效的用法
const userName = getUserProperty('name'); // 可以，'name' 是 User 的一个键
console.log(userName);

// 错误: 类型 '"country"' 的参数不能赋给类型 'keyof User' 的参数。
// const userCountry = getUserProperty('country');

// 示例：定义一个返回配置对象的函数
function loadAppConfig() {
  return {
    apiUrl: 'https://api.example.com',
    retryAttempts: 5,
    debugMode: false
  };
}

// 使用 ReturnType 推断 loadAppConfig 函数返回的配置对象的类型
type AppConfig = ReturnType<typeof loadAppConfig>;

// AppConfig 现在代表我们的配置对象类型，我们可以在应用程序的其他部分安全地使用该类型
function setupApi(config: AppConfig) {
  console.log(`API URL: ${config.apiUrl}`);
  console.log(`重试次数: ${config.retryAttempts}`);
  console.log(`调试模式: ${config.debugMode ? '启用' : '禁用'}`);
}

const config = loadAppConfig();
setupApi(config);

async function fetchTodoItem() {
  const response = await fetch('https://jsonplaceholder.typicode.com/todos/1');
  if (!response.ok) {
    throw new Error('Failed to fetch the todo item');
  }
  return await response.json();
}

// API 返回的 todo 项目的预期结构
type TodoItem = {
  userId: number;
  id: number;
  title: string;
  completed: boolean;
};

// 在异步上下文中直接使用 `fetchTodoItem` 函数
async function displayTodoItem() {
  const todo: Awaited<TodoItem> = await fetchTodoItem();
  // 现在你可以在完全类型支持下使用 `todo`
  console.log(`Todo Item: ${todo.id}, Title: ${todo.title}, Completed: ${todo.completed}`);
}

displayTodoItem();

// 定义一组角色
type UserRole = 'admin' | 'editor' | 'viewer';

// 定义权限为结构化对象
type Permission = {
  canCreate: boolean;
  canRead: boolean;
  canUpdate: boolean;
  canDelete: boolean;
};

// 将每个用户角色映射到其权限
const rolePermissions: Record<UserRole, Permission> = {
  admin: {
    canCreate: true,
    canRead: true,
    canUpdate: true,
    canDelete: true,
  },
  editor: {
    canCreate: true,
    canRead: true,
    canUpdate: true,
    canDelete: false, // 编辑者不能删除
  },
  viewer: {
    canCreate: false,
    canRead: true,
    canUpdate: false,
    canDelete: false, // 观众只能读取
  },
};

// 检查用户角色是否有权限执行某个操作的函数
function hasPermission(role: UserRole, action: keyof Permission): boolean {
  const permissions = rolePermissions[role];
  return permissions[action];
}

// 使用 hasPermission 的示例
console.log(hasPermission('admin', 'canCreate')); // true
console.log(hasPermission('editor', 'canUpdate')); // true
console.log(hasPermission('viewer', 'canDelete')); // false
console.log(hasPermission('editor', 'canDelete')); // false

type Todo = {
  title: string;
  description: string;
}

const partialTodo: Partial<Todo> = {}; 
// partialTodo 可以拥有 Todo 的任意属性，也可以没有任何属性

type Todo = {
  title: string;
  description: string;
}

// 更新待办事项的函数
function updateTodo(id: number, updatedFields: Partial<Todo>) {
  // 假设我们有一个 todos 数组存储所有的待办事项
  const todos: Todo[] = [
    { title: 'Learn TypeScript', description: 'Understand basic types' },
    { title: 'Write Blog Post', description: 'Draft a new article' }
  ];

  const todo = todos.find(todo => todo.id === id);
  if (todo) {
    Object.assign(todo, updatedFields);
  }
}

// 更新一个待办事项，只修改它的 description 属性
updateTodo(1, { description: 'Understand advanced types' });

type Todo = {
  title: string;
  description: string;
}

// requiredTodo 必须包含 Todo 的所有属性
const wrongRequiredTodo: Required<Todo> = { title: 'Hello' }; // 错误，没有 description 属性

const correctRequiredTodo: Required<Todo> = { title: 'Hello', description: 'World' }; // 正确

type Todo = {
  title?: string;
  description?: string;
}

// 创建一个新待办事项的函数
function createTodo(todo: Required<Todo>) {
  // 假设我们有一个 todos 数组存储所有的待办事项
  const todos: Todo[] = [];

  todos.push(todo);
}

// 尝试创建一个不完整的待办事项
const incompleteTodo = { title: 'Incomplete' };
createTodo(incompleteTodo); // 错误，description 属性是必需的

// 创建一个完整的待办事项
const completeTodo = { title: 'Complete', description: 'This is a complete todo' };
createTodo(completeTodo); // 正确

type Todo = {
  title: string;
  description: string;
  createdAt: Date;
}

const todoWithoutCreatedAt: Omit<Todo, "createdAt"> = { title: "Hello", description: "World" }; 
// todoWithoutCreatedAt 不包含 createdAt 属性

type Todo = {
  title: string;
  description: string;
  createdAt: Date;
}

// 移除 createdAt 属性
type TodoWithoutCreatedAt = Omit<Todo, "createdAt">;

// 模拟一个显示待办事项的函数
function displayTodo(todo: TodoWithoutCreatedAt) {
  console.log(`Title: ${todo.title}`);
  console.log(`Description: ${todo.description}`);
}

// 创建一个不包含 createdAt 属性的待办事项
const todo = { title: "Learn TypeScript", description: "Understand utility types" };
displayTodo(todo);