@the-/mixin-scene

Mixins for the-scene

Installation

$ npm install @the-/mixin-scene --save

Usage

'use strict'
const { withBusy } = require('@the-/mixin-scene')
const { TheScene } = require('@the-/scene')

async function tryExample() {
  const MyScene = withBusy(
    class MySceneBase extends TheScene {
      async doSomething() {
        await this.busyWhile(async () => {
          /* ... */
        })
      }
    },
  )
  const scene = new MyScene()
  await scene.doSomething()
}

tryExample().catch((err) => console.error(err))

API Guide

• module:@the-/mixin-scene
  • .bindDefaults()
  • .bindScope()
  • .helpers
  • .withBusy(Class)
  • .withEntities(Class)
  • .withEntry(Class)
  • .withFilter(Class)
  • .withId(Class)
  • .withLimit(Class)
  • .withPage(Class)
  • .withQuery(Class)
  • .withReady(Class)
  • .withResult(Class)
  • .withSort(Class)
• module:@the-/mixin-scene.helpers
  • .asClassMixin()
  • .asMethodWrap()
  • .injectProperties(Class)
• module:@the-/mixin-scene.withBusy.WithBusyMixed
  • .busyFor(duration)
  • .busyWhile(task)
  • .isBusy()
  • .waitWhileBusy()
• module:@the-/mixin-scene.withBusy
  • ~WithBusyMixed
• module:@the-/mixin-scene.withEntities
  • ~WithEntities
• module:@the-/mixin-scene.withEntities~WithEntities
  • .addEntities(entities,options)
  • .addEntity(entity,options)
  • .deleteEntity(entity)
  • .getEntities()
  • .receiveEntity(entity,options)
  • .updateEntity(entity)
• module:@the-/mixin-scene.withEntry
  • ~WithEntryMixed
• module:@the-/mixin-scene.withEntry~WithEntryMixed
  • .getEntry(options)
  • .hasEntryErrorFor(name)
  • .processEntry(handler)
  • .resetEntry()
  • .setEntry(newValues)
  • .setEntryErrors(errors)
• module:@the-/mixin-scene.withFilter
  • ~WithFilterMixed
• module:@the-/mixin-scene.withFilter~WithFilterMixed
  • .getFilter()
  • .setFilter(filter)
  • .setFilterByQ()
• module:@the-/mixin-scene.withId
  • ~WithHistoryMixed
• module:@the-/mixin-scene.withId~WithHistoryMixed
  • .getId()
  • .isKnownId(id)
• module:@the-/mixin-scene.withLimit
  • ~WithLimitMixed
• module:@the-/mixin-scene.withLimit~WithLimitMixed
  • .getLimit()
  • .nextLimit()
  • .setLimit(limit)
  • .updateToNextLimit()
• module:@the-/mixin-scene.withPage.WithPageMixed
  • .getPage()
• module:@the-/mixin-scene.withPage
  • ~WithPageMixed
• module:@the-/mixin-scene.withQuery
  • ~WithQueryMixed
• module:@the-/mixin-scene.withQuery~WithQueryMixed
  • .getQueryFromSearch(search)
  • .mergeQueryToSearch(query)
  • .queryWithSearch(search)
• module:@the-/mixin-scene.withReady
  • ~WithReadyMixed
• module:@the-/mixin-scene.withReady~WithReadyMixed
  • .ifReady(task)
  • .readyWhen(task)
  • .unlessReady(task)
• module:@the-/mixin-scene.withResult
  • ~WithResultMixed
• module:@the-/mixin-scene.withResult~WithResultMixed
  • .resultFor(action)
• module:@the-/mixin-scene.withSort
  • ~WithSortMixed

See API Guide for more detail

License

This software is released under the MIT License.

Links

• THE Labo