New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

chrome-webstore

Package Overview
Dependencies
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

chrome-webstore

Google Chrome Web Store HTTP Client

  • 1.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
157
increased by48.11%
Maintainers
1
Weekly downloads
 
Created
Source

chrome-webstore

npm-version

Google Chrome Web Store HTTP Client

Table of Contents

API

MethodArgumentsReturnsDescription
detail{id, related, more}{Object}Get full details about a Web Store item
items{search, category, rating, features, count, offset}[Array]Get list of Web Store items

detail

Get details for a Web Store item:

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.detail({id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk'})
  console.log(meta)
})()

Returns all available data for an item:

{
  id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk',
  name: 'Markdown Viewer',
  title: 'Markdown Viewer',
  slug: 'markdown-viewer',
  url: 'https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk',
  author: { name: 'simov.github.io', domain: null, url: null },
  description: '✔ Renders local and remote URLs\n✔ Granular access to remote origins\n✔ Multiple markdown parsers\n✔ Full control over the compiler options\n✔ Themes (including GitHub theme)\n✔ GitHub Flavored Markdown (GFM)\n✔ Auto reload on file change\n✔ Syntax highlighted code blocks\n✔ Table of Contents (TOC)\n✔ MathJax and Emoji support\n✔ Remembers scroll position\n✔ Markdown Content-Type detection\n✔ URL detection using RegExp\n✔ Toggle Content Security Policy (CSP)\n✔ Override page encoding\n✔ Settings synchronization\n✔ Raw and rendered markdown views\n✔ Free and Open Source\n\n✚ Local Files\n\n1. Navigate to `chrome://extensions`\n2. Locate Markdown Viewer and click on the `DETAILS` button\n3. Make sure that the `Allow access to file URLs` switch is turned on\n\n✚ Remote Files\n\n1. Click on the Markdown Viewer icon and select `Advanced Options`\n2. Add the origin that you want enabled for the Markdown Viewer extension\n\n✚ Compiler Options\n\n✔ Compilers: Marked, Remark\n✔ Documentation: https://github.com/simov/markdown-viewer#compiler-options\n\n✚ Content Options\n\n✔ Features: Autoreload, TOC, Mathjax, Emoji, Scroll\n✔ Documentation: https://github.com/simov/markdown-viewer#content-options\n\n✚ Full Documentation\n\n✔ https://github.com/simov/markdown-viewer',
  website: 'https://github.com/simov/markdown-viewer',
  support: 'https://github.com/simov/markdown-viewer/issues',
  version: '3.6',
  size: '223KiB',
  published: 'July 7, 2018',
  users: '46,860',
  rating: { average: 4.328467153284672, count: 137 },
  price: 'Free',
  purchases: null,
  category: { name: 'Productivity', slug: 'ext/7-productivity' },
  images:
   { '26x26': 'https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w26-h26-e365',
     '128x128': 'https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w128-h128-e365',
     '141x90': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w141-h90-e365',
     '220x140': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w220-h140-e365',
     '440x280': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w440-h280-e365',
     '460x340': null },
  languages: [ 'English' ],
  developer: { email: null, address: null, policy: null },
  type: 'Extension',
  status: 'Published',
  manifest: '{\n"update_url": "https://clients2.google.com/service/update2/crx",\n\n  "manifest_version": 2,\n  "name"            : "Markdown Viewer",\n  "version"         : "3.6",\n  "description"     : "Markdown Viewer",\n\n  "browser_action": {\n    "default_icon": {\n      "19" : "/images/icon19.png",\n      "38" : "/images/icon38.png"\n    },\n    "default_title": "Markdown Viewer",\n    "default_popup": "/content/popup.html"\n  },\n\n  "options_page": "/content/options.html",\n\n  "background" : {\n    "scripts": [\n      "/vendor/marked.min.js",\n      "/vendor/remark.min.js",\n      "/vendor/remark-html.min.js",\n      "/vendor/remark-slug.min.js",\n      "/vendor/remark-frontmatter.min.js",\n\n      "/background/compilers/marked.js",\n      "/background/compilers/remark.js",\n\n      "/background/storage.js",\n      "/background/webrequest.js",\n      "/background/detect.js",\n      "/background/inject.js",\n      "/background/messages.js",\n      "/background/mathjax.js",\n\n      "/background/index.js"\n    ],\n    "persistent": false\n  },\n\n  "web_accessible_resources": [\n    "/themes/github.css",\n    "/themes/github-dark.css",\n\n    "/themes/godspeed.css",\n    "/themes/new-modern.css",\n    "/themes/torpedo.css",\n    "/themes/vostok.css",\n\n    "/themes/ghostwriter.css",\n    "/themes/radar.css",\n    "/themes/foghorn.css",\n    "/themes/markdown.css",\n    "/themes/markedapp-byword.css",\n    "/themes/solarized-dark.css",\n    "/themes/solarized-light.css",\n\n    "/themes/screen.css",\n    "/themes/markdown5.css",\n    "/themes/markdown6.css",\n    "/themes/markdown7.css",\n    "/themes/markdown8.css",\n    "/themes/markdown9.css",\n    "/themes/markdown-alt.css"\n  ],\n\n  "icons": {\n    "16" : "/images/icon16.png",\n    "48" : "/images/icon48.png",\n    "128": "/images/icon128.png"\n  },\n\n  "homepage_url": "https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk",\n\n  "permissions": [\n    "storage",\n    "file:///*"\n  ],\n\n  "optional_permissions": [\n    "https://*/",\n    "http://*/",\n    "*://*/",\n    "webRequest",\n    "webRequestBlocking"\n  ]\n}\n'
}

Additionally a list of related extensions and more from the same developer can be included in the result set:

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.detail({id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk', related: true, more: true})
  console.log(meta)
})()

items

Get a list of items from Chrome Web Store:

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.items({search: 'markdown', category: 'extensions', count: 2})
  console.log(meta)
})()

Returns a list of items (only a subset of the detail data):

[
  { id: 'elifhakcjgalahccnjkneoccemfahfoa',
    name: 'Markdown Here',
    title: 'Write your email in Markdown, then make it pretty.',
    slug: 'markdown-here',
    url: 'https://chrome.google.com/webstore/detail/markdown-here/elifhakcjgalahccnjkneoccemfahfoa',
    author: { name: 'Adam Pritchard', domain: null, url: null },
    users: '80,395',
    rating: { average: 4.530864197530864, count: 324 },
    price: 'Free',
    category: { name: 'Productivity', slug: 'ext/7-productivity' },
    images:
     { '26x26': 'https://lh3.googleusercontent.com/8MnGCOk0daD0BIo1KPOICczj9L1gioa-v4wFIFgIZw5uWRdhDh2UoFZvlcsgisLIgb2o4j484w=w26-h26-e365',
       '128x128': 'https://lh3.googleusercontent.com/8MnGCOk0daD0BIo1KPOICczj9L1gioa-v4wFIFgIZw5uWRdhDh2UoFZvlcsgisLIgb2o4j484w=w128-h128-e365',
       '141x90': 'https://lh3.googleusercontent.com/0kFPdu9d7f3WZeQjQcNdzpy-vwVh6V_7HSXWQEKR4qV7W-9neRr7zIctUNHCMKo5huzRU0yu-Q=w141-h90-e365',
       '220x140': 'https://lh3.googleusercontent.com/0kFPdu9d7f3WZeQjQcNdzpy-vwVh6V_7HSXWQEKR4qV7W-9neRr7zIctUNHCMKo5huzRU0yu-Q=w220-h140-e365',
       '440x280': 'https://lh3.googleusercontent.com/0kFPdu9d7f3WZeQjQcNdzpy-vwVh6V_7HSXWQEKR4qV7W-9neRr7zIctUNHCMKo5huzRU0yu-Q=w440-h280-e365',
       '460x340': null },
    status: 'Published' },
  { id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk',
    name: 'Markdown Viewer',
    title: 'Markdown Viewer',
    slug: 'markdown-viewer',
    url: 'https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk',
    author: { name: 'simov.github.io', domain: null, url: null },
    users: '46,860',
    rating: { average: 4.328467153284672, count: 137 },
    price: 'Free',
    category: { name: 'Productivity', slug: 'ext/7-productivity' },
    images:
     { '26x26': 'https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w26-h26-e365',
       '128x128': 'https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w128-h128-e365',
       '141x90': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w141-h90-e365',
       '220x140': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w220-h140-e365',
       '440x280': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w440-h280-e365',
       '460x340': null },
    status: 'Published' }
]

Items Filter Parameters

The items method supports the following parameters:

ParameterExampleDescription
search'markdown'Search term to filter by
category'extensions'Category name to filter by
rating4Filter items by number of stars
features['free', 'gdrive']Filter items by feature set
count15Number of results to return
offset15Return up to results count starting from offset

Search the store by string:

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.items({search: 'markdown', category: 'extensions'})
  console.log(meta)
})()

category

Filter by category name:

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.items({category: 'collection/new_noteworthy_extensions'})
  console.log(meta)
})()

The following category names are available:

CategoryDescription
extensionsAll extensions
ext/[NAME]Specific extension's category
themesAll themes
theme/[NAME]Specific theme's category
collection/[NAME]Specific collection

Extension Categories ext/[NAME]

22-accessibility | 10-blogging | 15-by-google | 11-web-development | 14-fun | 6-news | 28-photos | 7-productivity | 38-search-tools | 12-shopping | 1-communication | 13-sports

Extension Collections collection/[NAME]

new_noteworthy_extensions | editors_picks_extensions | chrome_toolkit | screen_capture | social | personalize_chrome | tabs_control | artistic_extension | calendars_planners | chat_with_chrome | games_extension | everyday_extensions | 3p_accessibility_extensions | customize_your_new_tab_page | get_started | change_the_way_you_work | news_weather | pdf_extensions | lifehacker | blogger_extensions | online_tools | cyber_monday | annotate_the_web | music_extensions | writing_essentials | get_organized | pomodoro_extensions | save_it_for_later | ph | job_hunting | online_productivity | quotes_extensions | weather_extensions | procrastination_station | bad_day | relax_extensions

Extension Top Picks Collections collection/[NAME]

3p_accessibility_extensions | top_picks_blogging | top_picks_web-development | top_picks_fun | top_picks_news | top_picks_photos | top_picks_productivity | top_picks_search-tools | top_picks_shopping | top_picks_communication | top_picks_sports

Theme Categories theme/[NAME]

48-by-artists | 15-by-google

Theme Collections collection/[NAME]

editors_picks_themes | dark_themes | space_exploration | minimalist_themes | enchanting_places | heroes_themes | pretty_patterns | colorful_themes | car_themes | sunny_themes | blue_themes | flower_themes

rating

Filter by number of stars, one of: 5, 4, 3 or 2 stars:

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.items({category: 'extensions', rating: 4})
  console.log(meta)
})()

features

Filter by set of features:

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.items({category: 'extensions', features: ['offline', 'gdrive']})
  console.log(meta)
})()

Pick any number of the following:

ValueDescription
'offline'Runs Offline
'google'By Google
'free'Free
'android'Available for Android
'gdrive'Works with Google Drive

count

Request specific number of records (defaults to 5):

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.items({search: 'markdown', category: 'extensions', count: 15})
  console.log(meta)
})()

offset

Return up to results count starting from offset (useful for pagination):

var webstore = require('chrome-webstore')

;(async () => {
  var meta = await webstore.items({
    search: 'markdown', category: 'extensions', count: 10, offset: 10
  })
  console.log(meta)
})()

Requires the category parameter!

Examples

node examples/detail.js [example index]
node examples/items.js [example index]

Keywords

FAQs

Package last updated on 15 Jul 2018

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc