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-data-record-meta

v0.1.0

Published

Record meta management for Ember applications.

Downloads

466

Readme

Ember Data Record Meta

NPM Version Build Status Code Style: Prettier Conventional Commits

Record meta management for Ember applications.

Compatibility

  • Ember.js v3.12 or above (lower probably works as well, but isn't tested explicitly)
  • Ember CLI v2.13 or above
  • Node.js v10 or above

Installation

ember install ember-data-record-meta

Usage

Normalizing and Storing Record Meta

// app/serializers/project.js

import { inject as service } from '@ember/service';
import { camelize } from '@ember/string';
import JSONAPISerializer from '@ember-data/serializer/json-api';

export default class ProjectSerializer extends JSONAPISerializer {
  @service recordMeta;

  normalize() {
    this.recordMeta.normalizeRecordMeta(...arguments, {
      keyTransform: camelize,
    });

    return super.normalize(...arguments);
  }
}

Using the normalizeRecordMeta method, we can normalize and store record meta on the record-meta service so we can access it later on.

normalizeRecordMeta accepts the same arguments as normalize, but also an additional options object.

If the meta keys returned by the API do not have the desired format, you can specify a keyTransform function.

keyTransform receives a meta key as its sole argument and should return that same meta key in the desired format.

In the example above, we use the camelize util from @ember/string to camelize all meta keys returned by the API.

Accessing Record Meta

Using the record-meta Helper

{{! app/templates/project.hbs }}

{{#let (record-meta this.project) as |projectMeta|}}
  {{#if projectMeta.userCanDelete}}
    <button {{on "click" this.deleteProject}} type="button">
      Delete Project
    </button>
  {{/if}}
{{/let}}

Using the record-meta Service

// app/controllers/project.js

import Controller from '@ember/controller';
import { inject as service } from '@ember/service';

export default class ProjectController extends Controller {
  @service recordMeta;

  get project() {
    return this.model;
  }

  get projectMeta() {
    return this.recordMeta.getRecordMeta('project', this.project.id);
  }
}

💡 Working versions of these code examples can be found in this addon's dummy app.

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.