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

cask

v0.0.0

Published

cask ====

Downloads

3

Readme

Cask

Cask is a micro-framework for creating template-based web pages with Express. Cask currently only supports Mustache templating.

Basic Usage

npm install cask

Cask allows pages to be declaritively defined as modules similar to Connect middleware. The page can then be rendered by passing a Response instance, a context object, and the middleware callback. For example:

page.js
=======

var pages = require("cask").pages;

module.exports = function (response, item, next) {
    pages("templates").load("page.html", function (error, response) {
        page.addStyleSheet("/static/css/style.css");
        page.renderTo(response, { result: item }, next);
    });
};

app.js
======

var app  = express(),
    page = require("./page");

. . .

app.get("/page", function (request, response, next) {
    var item = { message: "hello world" };
    page(response, item, next);
});

API Details

cask.pages([templateDirectory])

  • templateDirectory - Defaults to CWD. The base directory to load load templates from.

Creates a new PageLoader for loading pages.

PageLoader.load(template, callback)

  • template - the file name of the template to create the page from.
  • callback - called when the template has been loaded and compiled. The callback is passed two arguments (error, page).

Creates a Page instance from a template file.

Page.addPartial(name, template, callback)

  • name - the name by which the partial will be refernced in templates.
  • template - the template that defines the partial.
  • callback - called when the partial has been loaded and compiled. The callback is passed two arguments (error, page). page is a self-reference to the Page.

Makes a partial available to the rendering context.

Page.addScript(href)

  • href - the URL of the script to add to the page.

addScript allows a page definition to declare a script dependency. The page will try to make smart use of scripts and will only load each script once (regardless of how many times the same script is declared) at the end of the page body.

Page.addStyleSheet(href)

  • href - the URL of the stylesheet to add to the page.

addStyleSheet allows a page definition to declare a stylesheet dependency. The page will try to make smart use of stylesheets and will only load each stylesheet once (regardless of how many times the same stylesheet is declared).

Page.renderTo(response, context, next)

  • response - the Express response instance that the page content should be rendered to.
  • context - a hash of attributes to be used by the template engine.
  • next - the 'next middleware' callback. This is typically used for error handling.

Cause the page content to be rendered as a response to a request.