Socket
Socket
Sign inDemoInstall

ember-raf-scheduler

Package Overview
Dependencies
324
Maintainers
4
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

ember-raf-scheduler

The default blueprint for ember-cli addons.


Version published
Maintainers
4
Weekly downloads
36,293
decreased by-34.75%

Weekly downloads

Readme

Source

Build Status

ember-raf-scheduler

Super simple RAF scheduler that integrates with the Ember runloop

Compatibility

  • Ember.js v3.12 or above (possibly older, but older than 3.12 is untested)
  • Ember CLI v4.4 or above
  • Node.js v16 or above

Basics

Super simple example:

import { scheduler } from 'ember-raf-scheduler';

// schedule a job
const job = scheduler.schedule('measure', () => {
  console.log('Hello, world!');
});

// cancel the job
scheduler.forget(job);

There are 4 queues:

  • sync - Wrapped in a runloop, use this queue for all Ember related work
  • layout - This queue can be used for touch up on the Ember work in general (small DOM manipulations, for instance)
  • measure - General measurements should occur here
  • affect - Fixup DOM manipulation after measurements have been done

Tokens

Tokens can be created and passed into the scheduler. All jobs that were scheduled with a token can be cancelled by cancelling the parent token.

import { scheduler, Token } from 'ember-raf-scheduler';

export default Component.extend({
  init() {
    this.token = new Token();
  },

  willDestroy() {
    scheduler.forget(this.token);
  },

  schedule(queue, job) {
    scheduler.schedule(queue, job, this.token);
  }
});

Perf Notes

Measurements in RAFs are basically free if you do them before any other DOM manipulation (same rules as standard forced layouts, etc), so you should batch all measurements in measure and if possible avoid using the sync and layout queues. There are times when it's necessary to do Ember specific manipulations (for instance, you need to use set and you want the template to render before you measure) which is what the sync and layout queues are for.

Installation

  • git clone <repository-url> this repository
  • cd ember-raf-scheduler
  • yarn install

Running

Running Tests

  • yarn test (Runs ember try:each to test your addon against multiple Ember versions)
  • ember test
  • ember test --server

Building

  • ember build

For more information on using ember-cli, visit https://ember-cli.com/.

Keywords

FAQs

Last updated on 09 Sep 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc