userscript-meta
v1.0.1
- Types
- ESM
- CJS
- License
- MIT
- Deps
- 0
- Install Size
- -
- Vulns
- 0
- Published
$
npm install userscript-meta$
pnpm add userscript-meta$
yarn add userscript-meta$
bun add userscript-meta$
deno add npm:userscript-meta$
vlt install userscript-metauserscript-meta
Parse and stringify Userscript metadata.
Installation
npm install userscript-meta --save
API
parse(string)
parse userscript metadata to an object.
const userscript = require('userscript-meta')
userscript.parse(`
// ==UserScript==
// @name Userscript name
// @version 1.0
// @match http://www.example.com/*
// @match http://www.example.org/*
// ==/UserScript==
`)
equals to
{
name: 'Userscript name',
version: '1.0',
// Field which has multiple value will parsed to an array
match: [
'http://www.exmaple.com/*',
'http://www.exmaple.org/*',
]
}
stringify(object)
const userscript = require('userscript-meta')
userscript.stringify({
name: 'Userscript name',
version: '1.0',
match: [
'http://www.exmaple.com/*',
'http://www.exmaple.org/*',
]
})
equals to
// ==UserScript==
// @name Userscript name
// @version 1.0
// @match http://www.example.com/*
// @match http://www.example.org/*
// ==/UserScript==
license
MIT