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

@financial-times/n-content-decorator

v1.0.5

Published

Decorates FT content prior to rendering

Downloads

24

Readme

Coverage Status

#n-content-decorator

Provides decoration for content sourced either directly from the next Elastic Search cluster, or via the next-graphql-api, for compatibility for rendering content cards.

##Options supported;

###Decoration type

mutateOriginal: true will mutate the object passed to it.

mutateOriginal: false will return the decoration object, which can be merged in with the original object by the calling application (eg. `Object.assign(original, decoration)``).

false is the default option and need not be passed in.

###Excluded Taxonomies

excludeTaxonomies: true prevents specific taxonomies (organisations, regions, people) from appearing in the tag that is returned.

excludeTaxonomies: false leaves taxonomies unaffected.

false is the default and need not be passed in.

###Minor Branding

Determines how brand (if content is associated with a brand) is displayed.

minorBranding: true brand appears below standfirst and primary Tag is shown eg. as on stream list.

minorBranding: false brand replaces primary Tag at the top of the card.

false is the default option and need not be passed in.

(NOTE: the intention is to migrate this display option to n-card rather than handle it here)

##Example usage

###With an array of content items

####With mutateOriginal: false

const decoration = require('ft-n-content-decoration');

contentArray.map(content => Object.assign(content, decoration(content, {options})));

####With mutateOriginal: true

const decorateContent = require('ft-n-content-decoration');

contentArray.map(content => decorateContent(content, {options}));