npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ember-resource-metadata

v1.0.2

Published

Per-resource metadata for ember-data

Downloads

652

Readme

ember-resource-metadata

The JSONAPI spec allows any resource to have its own meta object. Ember Data doesn't support meta in this position. This addon exists to fill the gap.

It provides an AdapterMixin, a SerializerMixin, a Service, and a Helper as described in the following sections:

AdapterMixin

We provide a mixin that you can apply to Ember Data's JSONAPIAdapter that stores per-resource metadata into a service. Use it like:

import AdapterMixin from 'ember-resource-metadata/adapter-mixin';
import DS from 'ember-data';
export default DS.JSONAPIAdapter.extend(AdapterMixin);

It expects to receive JSONAPI-compliant responses from the server (because it will expect to find /data/id, /data/type, and /data/meta in the response).

Service

The resource-metadata service has the following methods for accessing metadata:

  • peek(record): takes an Ember Data record or any object with a type and id. Returns an Ember.Object representing the record's metadata. Returns undefined if we don't have any metadata for the record.
  • read(record): takes the same input as peek, but this always returns an Ember.Object, which will be updated to contain the metadata for the record even if it's added at a later time.
  • write(record, metadata): saves all the properties of metadata as the metadata for record. This is a per-property merge with any prior metadata.

To access these methods, inject the service into a Component, Controller, Route, etc:

export default Ember.Component.extend({
  resourceMetadata: Ember.inject.service(),
  actions: {
    bumpVersion() {
      let service = this.get('resourceMetadata');
      let model = this.get('model');
      let meta = service.read(model);
      service.write(model, { version: meta.version + 1 });
    }
  }
})

SerializerMixin

We provide a mixin that you can apply to Ember Data's JSONAPISerializer that writes per-resource metadata back out to the server.

Use it like:

import SerializerMixin from 'ember-resource-metadata/serializer-mixin';
import DS from 'ember-data';
export default DS.JSONAPISerializer.extend(SerializerMixin);

Helper

The meta-for-resource helper is implemented via read as defined in the previous section, so you can use it easily from templates:

{{#with (meta-for-resource model) as |meta|}}
  Your meta.freshness is {{meta.freshness}}
{{/with}}

Installation

  • git clone <repository-url> this repository
  • cd ember-resource-metadata
  • npm install

Linting

  • npm run lint:js
  • npm run lint:js -- --fix

Running

Running tests

  • ember test – Runs the test suite on the current Ember version
  • ember test --server – Runs the test suite in "watch mode"
  • ember try:each – Runs the test suite against multiple Ember versions

Building

  • ember build

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

License

This project is licensed under the MIT License.