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

monode-serverless

v0.1.29

Published

This contains some basic libraries for using Mondoe with the serverless framework.

Downloads

6

Readme

Monode Serverless

Monode is an infastructure as code framework for configuring cloud services in a TypeScript project. This libarary in particular provides the nessecary dependencies for a Monode project that exports to a serverless framework based project.

Installation

This library should only be installed using the Monode CLI

Usage

Cloud Components

Cloud components are bundles of cloud resources that work together. For example, if you wanted to define a new cloud component:

  1. Create a file in your Monode project and name it <ComponentName>.ts.
  2. At the top of the file add import { CloudComponent } from 'monode-serverless';
  3. Define and export your cloud component instance. export const ComponentName = CloudComponent.defineNew({...}); The example project contains a more detailed example of an S3 cloud component.

Cloud Component Types

Often multiple cloud components follow the same pattern. In these cases you might want to use a Cloud Component Type.

  1. Create a file in your Monode project, and name it <TypeName>.ts. By convention these files reside under <project-root>/src/cloud-types.
  2. At the top of the file add import { CloudComponentType } from 'monode-serverless';
  3. Export your cloud component type. export const <TypeName> = CloudComponentType.defineNew({...});
  4. As part of CloudComponentType.defineNew's args, create the function that will be used to define instances of this cloud component type. It should have a look something like this.
defineNew(args: <argtype>) {
  return {
    cloudFormationExports: {
      functions: {
        ...
      },
      resources: {
        ...
      },
    },
    ...
  }
}

Here, the functions entries will be translated to serverless function enteries, and the resources entries will be translated to serverless/CloudFormation resoruce entries. Feel free to explore the example cloud component types.

Compiling

When you run $ mnd compile or $ monode compile in your Monode project, Monode will analyze the cloud componet types and instances, and export their config and code to the sepcified serverless project.

Dependencies