Class RelationBuilder<T>

constructor

• new RelationBuilder<T extends Model<any>>(
      model: T,
      queryBuilder: QueryBuilder,
      resource?: string,
  ): RelationBuilder<T>

  Creates a new relation builder instance. Sets up the query builder and configures the resource path.

  Type Parameters

  • T extends Model<any>

  Parameters

  • model: T

    The model instance to build relations for
  • queryBuilder: QueryBuilder

    Query builder instance for constructing API requests
  • Optionalresource: string

    Optional custom resource name for the relation

  Returns RelationBuilder<T>

  Throws

  If the model or query builder is invalid

queryBuilder

filter

• filter(filters: Record<string, any>): RelationBuilder<T>

  Adds filter conditions to the query. Supports more complex filtering operations than where().

  Parameters

  • filters: Record<string, any>

    Object containing filter conditions

  Returns RelationBuilder<T>

  The relation builder instance for chaining

  Example

  const posts = await user.posts.filter({
    created_at: { gt: '2023-01-01' },
    status: ['published', 'draft']
  }).all();
  Copy

find

• find(id: string | number): Promise<T>

  Fetches a model instance by ID from the API. Makes a GET request to retrieve the model data.

  Parameters

  • id: string | number

    The ID of the model to fetch

  Returns Promise<T>

  A promise that resolves to the fetched model instance

  Throws

  If the model is not found

  Example

  const post = await user.posts.find(123);
  Copy

id

• id(id: string | number): T

  Gets a model instance by ID without making an API request. Creates a new model instance with the given ID for local operations.

  Parameters

  • id: string | number

    The ID of the model to get

  Returns T

  A new model instance with the given ID

  Example

  const post = user.posts.id(123);
  Copy

limit

• limit(n: number): RelationBuilder<T>

  Limits the number of results returned. Restricts the query to return at most n results.

  Parameters

  • n: number

    The maximum number of results to return

  Returns RelationBuilder<T>

  The relation builder instance for chaining

  Example

  const posts = await user.posts.limit(10).all();
  Copy

offset

• offset(n: number): RelationBuilder<T>

  Sets the offset for pagination in the query results. Skips n records before starting to return results.

  Parameters

  • n: number

    The number of records to skip

  Returns RelationBuilder<T>

  The relation builder instance for chaining

  Example

  const posts = await user.posts.offset(20).limit(10).all(); // Get posts 21-30
  Copy

orderBy

• orderBy(sort?: string, direction?: string): RelationBuilder<T>

  Adds an order by clause to the query. Sorts the results by the specified field and direction.

  Parameters

  • sort: string = 'id'

    The field to order by (default: 'id')
  • direction: string = 'asc'

    The direction to order in ('asc' or 'desc', default: 'asc')

  Returns RelationBuilder<T>

  The relation builder instance for chaining

  Example

  const posts = await user.posts.orderBy('created_at', 'desc').all();
  Copy

where

• where(where: Record<string, any>): RelationBuilder<T>

  Adds a where clause to the query. Filters results based on exact field-value matches.

  Parameters

  • where: Record<string, any>

    Object containing field-value pairs to filter by

  Returns RelationBuilder<T>

  The relation builder instance for chaining

  Example

  const posts = await user.posts.where({ published: true }).all();
  Copy