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();
// その他にも検索、リレーション操作など
機能
さらに詳しく知りたい場合は、はじめにセクションに進んで開発を始めましょう。