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

varufaker

v2.0.2

Published

Small utility to generate log traces based on a template

Downloads

10

Readme

varufaker

Small utility to generate log traces based on a template, supporting elastic Search indexing, files and stdout

Usage

Install nodejs

npm install -g varufaker
varufaker --help

  Usage: varufaker [options] [command]


  Commands:

    elastic   Writes traces to Elastic Search
    stdout    Writes traces to stdout

  Options:

    -h, --help                 output usage information
    -V, --version              output the version number
    --every <every>            The delay between writes (milliseconds) [default: 1000]
                               Environment var: VA_EVERY
    --iterations <iterations>  The number of traces to write [default: 100]
                               Environment var: VA_ITERATIONS
    --template <template>      The template trace to write (see https://github.com/marak/Faker.js/) [default: ./lib/templates/tid.tpl]
                               Environment var: VA_TEMPLATE
    --esurl <esurl>            The Elastic Search endpoint (add your user pass if Shield is enabled) [default: http://localhost:9200]
                               Environment var: VA_ESURL
    --esindex <esindex>        The ElasticSearch index to write to (faker format supported) [default: varufaker-{{tid.yyyymmdd}}]
                               Environment var: VA_ESINDEX
    --verbose                  Write debug info to the stderr
                               Environment var: VA_VERBOSE

  Examples:

  Write to stdout
    $ varufaker stdout

  Write to a file
    $ varufaker stdout > ./out.txt

  Write to elasticsearch server directly[1]
    $ varufaker elastic
  [1] Only JSON templates are supported in this writer

API

const varufaker = require('varufaker');

let writer = varufaker({ // ALL OPTIONAL 
  // same options than in command line
  every: 1000,
  iterations: 1000,
  template: '/path/to/template',
  verbose: true,  // Defaults to false
  // API only properties
  templateStr: 'my {{cool}} template', // This takes precedence over the template property above
  // Add your own stream to get the traces in your logic
  stream: {
    // Called with the trace (string) to write 
    write: function(str) { 
      // do whatever u want...
    }
  }
});

// ADD your own fakes to be used in the templates. E.g.
// { "myCustomField": "{{custom.myFake}}" }
varufaker.faker.custom = {
  myFake() {
    return 'This is Sparta';
  }
};

//write to stdout
writer.stdout()
  .then(success => process.stderr.write('All went fine? ' + success)); // dont write to stdout spurious traces ;)

// write to your custom stream
writer.stream().then(...);

License

Copyright 2015, 2016 Telefónica Investigación y Desarrollo, S.A.U

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.