kylefang/pocketbase-typegen
1
0
Fork 0
mirror of https://github.com/zhigang1992/pocketbase-typegen.git synced 2026-04-29 04:35:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

version bump

Browse Source
This commit is contained in:
Patrick
2024-11-27 20:44:39 +11:00
parent f10506db3d
commit 776dc51bb0
3 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -11,9 +11,10 @@ This will produce types for all your PocketBase collections to use in your front
## Version Support
| PocketBase | pocketbase-typegen | npx command |
|------------|--------------------| ------------------------------------------------------------------------------ |
| v0.23.x | v1.2.x | npx pocketbase-typegen --db ./pb_data/data.db --out pocketbase-types.ts |
| v0.8.x | v1.1.x | npx pocketbase-typegen@1.2.1 --db ./pb_data/data.db --out pocketbase-types.ts |
| ---------- | ------------------ | ------------------------------------------------------------------------------ |
| v0.23.x | v1.3.x | npx pocketbase-typegen --db ./pb_data/data.db --out pocketbase-types.ts |
| v0.18.x | v1.2.x | npx pocketbase-typegen@1.2.1 --db ./pb_data/data.db --out pocketbase-types.ts |
| v0.8.x | v1.1.x | npx pocketbase-typegen@1.1.1 --db ./pb_data/data.db --out pocketbase-types.ts |
| v0.7.x | v1.0.x | npx pocketbase-typegen@1.0.13 --db ./pb_data/data.db --out pocketbase-types.ts |
## Usage
@@ -83,10 +84,10 @@ Using PocketBase SDK v0.18.3+, collections can be [automatically typed](https://
```typescript
import { TypedPocketBase } from "./pocketbase-types"
const pb = new PocketBase('http://127.0.0.1:8090') as TypedPocketBase
const pb = new PocketBase("http://127.0.0.1:8090") as TypedPocketBase
await pb.collection('tasks').getOne("RECORD_ID") // -> results in TaskResponse
await pb.collection('posts').getOne("RECORD_ID") // -> results in PostResponse
await pb.collection("tasks").getOne("RECORD_ID") // -> results in TaskResponse
await pb.collection("posts").getOne("RECORD_ID") // -> results in PostResponse
```
Alternatively, you can use generic types for each request, eg:

2
dist/index.js vendored
View File

@@ -326,7 +326,7 @@ async function main(options2) {
import { program } from "commander";
// package.json
var version = "1.2.1";
var version = "1.3.0";
// src/index.ts
program.name("Pocketbase Typegen").version(version).description(

2
package.json
View File

@@ -1,6 +1,6 @@
{
"name": "pocketbase-typegen",
"version": "1.2.1",
"version": "1.3.0",
"description": "Generate pocketbase record types from your database",
"main": "dist/index.js",
"bin": {