Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

data-store

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

data-store

Store data from YAML front matter in HTML data-attributes.

0.1.1
Source
npm

Version published: 11 years ago

Weekly downloads: 30K; decreased by-27.05%

Maintainers: 1

Weekly downloads

Created: 11 years ago

Source

data-store

Store data from YAML front matter in HTML data-attributes.

Install

Install with npm:

npm i data-store --save-dev

Usage

var dataStore = require('data-store');

This is foo.html:

---
title: Home
---
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Document</title>
  </head>
  <body>
    this is the body
  </body>
</html>

.set()

To store the YAML front matter from foo.html in data attributes:

// Read the file in as a string
var str = fs.readFileSync('foo.html');

// pass the string to data-store
var store = dataStore(str);

To store the data from the front-matter in data attributes (by default data is stored on data-metadata on a script tag with the metadata id):

store.set();
console.log(store.html);

Results in:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Document</title>
  </head>
  <body>
    this is the body
  <script type="text/x-metadata" id="metadata" data-metadata="{\"title\":\"Home\"}"></script></body>
</html>

.get()

Get the data:

store.get('metadata');

id

Set a custom id:

store.set('foo');
// to get the data:
store.get('foo');

extend

YAML front matter is stored by default. If an object is passed any existing front-matter will be extended.

If front-matter doesn't exist, just pass an object to store:

store.set({name: 'Jon Schlinkert'});

Results in:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Document</title>
  </head>
  <body>
    this is the body
  <script type="text/x-metadata" id="metadata" data-metadata="{\"name\":\"Jon Schlinkert\"}"></script></body>
</html>

Or with a custom id:

store.set('foo', {name: 'Jon Schlinkert'});

Results in:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Document</title>
  </head>
  <body>
    this is the body
  <script type="text/x-metadata" id="foo" data-metadata="{\"name\":\"Jon Schlinkert\"}"></script></body>
</html>

Author

Jon Schlinkert

Brian Woodward

License

This file was generated by verb-cli on May 01, 2014.

Keywords

FAQs

What is data-store?

Is data-store popular?

Is data-store well maintained?

Package last updated on 01 May 2014

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