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

as_eco

v0.1.1

Published

Asynchronous, streaming embedded CoffeeScript templating engine.

Downloads

5

Readme

#Asynchronous, Streaming, Embedded CoffeeScript Templates

AsEco does pretty much the same thing that ECO templates templates do, with the following delicate differences:

  • Streaming: Rather than rendering the template completely into a buffer first, and then outputting that buffer to the client, AsEco templates output chunks of their content directly and immediately into the output stream as soon as that makes sense.

  • Asynchronous: AsEco support calling asynchronous methods from within the template, i.e. methods that don't do anything at the time, but return their result at a later time using a callback function. AsEco templates understand this paradigm and pause the output stream at this point until the callback method gets called. The rendering continues normally after that.

Both features, combined with Asynchronous Futures, allow a web server that uses AsEco templates to output the static headers of their response immediately to the client browser, while waiting until data from the database is loaded. The remaining parts of the response are rendered in chunks as soon as the required data becomes available from the backend. This gives the browser a chance to prefetch static assets of the web page (CSS, JavaScript) in parallel while the server generates the remaining response.

Usage

Working examples are given in the example directory.

Here is an example CoffeeScript file that renders a template.

# Load the required libraries.
AsyncFuture = require 'async_future.coffee'
AsEco = require 'as_eco'

# Simulate slow database operations.
simulate_delay = (delay, result, done_callback) ->
  setTimeout (-> done_callback(result)), delay
user_loader = new AsyncFuture simulate_delay, 1000, 'John Doe '
city_loader = new AsyncFuture simulate_delay, 2000, 'Los Angeles'


# The name of the template file to render.
template_filename = './template.as_eco'

# The data that should be rendered into the template.
data = {user: user_loader, city: city_loader}

# The template writes output by calling this function.
out_stream = console.log

# The template calls this function when it is done rendering.
done_callback = -> console.log '\n\n[rending finished]'

console.log '[rendering start]\n'
AsEco.render_file template_filename,
                  data,
                  console.log,
                  done_callback

Here is the corresponding template.

This part is sent immediately.

<% async @user.get, user %>
This part is sent as soon as the server receives the user information from its backend.
<%= user %>

While we wait for the city data to become available, 
we can use CoffeeScript to define and massage data.
<% a = 1 %>
<%= a %>

<% async @city.get, city %>
This part is sent after the expensive backend operation to retrieve city data finishes.
<%= city %>