Skip to content
Lucent
Esc
↑↓navigate↵open
On this page

api.house

Members

api.house.contains()

api.house.contains(query: ItemQuery, quantity?: number): Effect.Effect<boolean>
Name Type Required Default Description
query ItemQuery
quantity number 1 The minimum quantity required.

Returns: boolean

Errors: never

api.house.get()

api.house.get(query: ItemQuery): Effect.Effect<LiveItem | null>
Name Type Required Default Description
query ItemQuery

Returns: LiveItem | null

Errors: never

api.house.getAll()

api.house.getAll(): Effect.Effect<readonly LiveItem[]>

Returns: readonly LiveItem[]

Errors: never

api.house.getAvailableSlots()

api.house.getAvailableSlots(): Effect.Effect<number>

Returns: number

Errors: never

api.house.getSlots()

api.house.getSlots(): Effect.Effect<number>

Returns: number

Errors: never

api.house.getUsedSlots()

api.house.getUsedSlots(): Effect.Effect<number>

Returns: number

Errors: never

Type preview
Open page

Last updated on September 26, 2026

Was this page helpful?