TypeScript SDK
介绍
欢迎阅读 Orion for Laravel TypeScript SDK 文档。
工作原理
定义一个带类型化属性的模型，设置资源名称，配置 API URL，就这样——一切就绪，可以开始使用 API 了 ✨
import {Orion} from "@tailflow/laravel-orion/lib/orion";
import {Model} from "@tailflow/laravel-orion/lib/model";
Orion.init('https://your-api.test');
Orion.setToken('access-token-here');
export class Post extends Model<{
title: string,
body: string
}>
{
public $resource(): string {
return 'posts';
}
}
// 获取文章列表
const posts = await Post.$query().get();
// 搜索文章
const posts = await Post.$query().lookFor('some value').search();
// 创建文章
const newPost = await Post.$query().store({
title: 'New post' // <-- 属性是有类型的，所以这里能获得很好的自动补全
});
console.log(newPost.$attributes.title); // <-- 这里也一样
// 获取文章
const post = await Post.$query().find(5);
// 更新文章
post.$attributes.title = 'Updated post';
await post.$save();
// 或者
await post.$save({title: 'Updated post'}); // <-- 这里也是
// 或者
const updatedPost = await Post.$query().update(5, {
title: 'Updated title' // <-- 当然，这里也是
});
// 删除文章
const deletedPost = await Post.$query().delete(5);
// 或者
await post.$destroy();
// 还有更多：搜索、关联操作等
功能特性
准备好深入了解了吗？前往快速上手章节，开始构建吧。