Skip to content

Commit

Permalink
fix: improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elribonazo committed Jan 26, 2025
1 parent 60b5f76 commit e3439f5
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion packages/ridb-core/src/schema/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,18 @@ export type SchemaType = {
/**
* Represents a schema, including its definition and related methods.
*
* You may be trying to build a storage, in any other can u won't need access tho this class.
* Check this example
*
* ```typescript
* class MyStorage extends <T extends SchemaTypeRecord> extends BaseStorage<T> {
* example() {
* const schema: Schema<any> = this.getSchema("mySchema")
* }
* }
* ```
* You alwayswill have access to getSchema through the Storage class.
*
* @template T - The schema type.
*/
export class Schema<T extends SchemaType> {
Expand Down

0 comments on commit e3439f5

Please sign in to comment.