Giter Club home page Giter Club logo

recorder's Introduction

recorder

GitHub release Build Status GoDoc Go Report Card Coverage Status

A go package to capture stdout and stderr generated by your code

Installation

You can download the package using

go get github.com/amalfra/recorder/v3

Usage

Next, import the package

import (
  "github.com/amalfra/recorder/v3"
)

You can record output from both Stdout as well as Stderr. The recorded output will be available as string. The following two structs are available for your use:

  • recorder.Stdout - Can be used for recording from Stdout
  • recorder.Stderr - Can be used for recording from Stderr

There are four struct methods which can be used to control recording process:

  • Start - To start recording
  • Stop - To stop recording
  • GetOutput - To return recorded output as string
  • ClearOutput - To clear the recorded output

To record follow below steps:

  1. first create the instance of struct as follows:
rec := new(recorder.Stdout)

or if to record from Stderr do

rec := new(recorder.Stderr)
  1. Now call the Start method as follows:
rec.Start()

From now onwards all Stdout or Stderr output will be captured.

  1. Call Stop method as follows when you want to stop recording process:
rec.Stop()
  1. Now get the recorded output by calling the GetOutput method. It will return the recorded output string
out := rec.GetOutput()

Development

Questions, problems or suggestions? Please post them on the issue tracker.

You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running make test. Feel free to contribute ๐Ÿ˜

UNDER MIT LICENSE

The MIT License (MIT)

Copyright (c) 2017 Amal Francis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.