Class BoxesDao

Handles all interactions with the comics-db 'boxes' table.

Create operations:

  • createBox(box): Promise - Creates a single Box and reads the result. Experimental. Read operations:
  • getBox(boxId): Promise - Reads a single Box by ID.
  • getBoxes(): Promise<Box[]> - Reads all Boxes.

Hierarchy

  • Dao
    • BoxesDao

Constructors

constructor

Properties

db

Accessors

primaryKey tableName

Methods

createBox getBox getBoxes

Constructors

constructor

  • new BoxesDao(db): BoxesDao

  • Parameters

    • db: Knex<any, any[]>

    Returns BoxesDao

Properties

Protecteddb

db: Knex<any, any[]>

Accessors

StaticprimaryKey

  • get primaryKey(): string

  • The primary key of the table as defined in the database.

    Returns string

StatictableName

  • get tableName(): string

  • The name of the table as defined in the database.

    Returns string

Methods

createBox

  • createBox(box): Promise<Box>
  • Experimental

    Creates a single Box and reads the result.

    Parameters

    • box: Box

      The Box to create. Note: The value Box.box_id is ignored and generated by the comics-db.

    Returns Promise<Box>

    The Box that was created.

getBox

  • getBox(boxId): Promise<null | Box>

  • Reads a single Box by ID.

    Parameters

    • boxId: string

      The ID of the box.

    Returns Promise<null | Box>

    Box or null if boxId does not exist.

getBoxes

  • getBoxes(): Promise<Box[]>

  • Reads all Boxes.

    Returns Promise<Box[]>

    BoxModel[]

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods