Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

nuxt-logsnag

intevel13MIT1.2.0TypeScript support: included

Simple LogSnag integration for Nuxt 3

nuxt, logsnag, nuxtjs, nuxt-module, vue3, nuxt3, logsnag-module, nuxt-logsnag, nuxtlogsnag, nuxt-community

readme

Nuxt LogSnag 📰

npm version npm downloads Github Actions CI License

LogSnag integration for Nuxt 3

Features

  • Nuxt 3 ready
  • Easy integration
  • Handy composables
  • TypeScript support

Setup

yarn add nuxt-logsnag # yarn
npm i nuxt-logsnag # npm

Basic usage

Firstly, you need to add nuxt-logsnag to your Nuxt config.

// nuxt.config.js

{
    modules: ["nuxt-logsnag"],
    logsnag: {
        token: "<YOUR_LOGSNAG_API_TOKEN>"
    }
}

Set your api token in the nuxt.config or as an environment variable using: LOGSNAG_API_TOKEN

Then you can start using nuxt-logsnag in your setup function!

<script setup>
const { publish } = useLogSnag();

onMounted(async () => {
  var event = {
    project: "Test",
    channel: "nuxttest",
    event: "Tested Module!",
    description: "Hey, I just tested the Nuxt3 LogSnag module!",
    icon: "🎉",
    notify: true,
  };
  await publish(event);
});
</script>

nuxt-logsnag

Development

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using yarn dev or npm run dev

License

MIT License - 2022 Conner Luka Bachmann

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.2.0 (2022-04-26)

Features

  • main: renamed publishEvent to publish (262bec9)

Bug Fixes

  • docs: method rename (25f438b)
  • main: public config to private (6fb9026)
  • main: removed unnecessary logs (d03c928)

1.1.0 (2022-04-23)

Features

  • chore: added standard-version (c21991c)
  • chore: created nuxt module (59cda50)
  • chore: finished module functionality (9dff57f)
  • chore: license & code_conduct (00793d9)
  • chore: renovated config (99d977d)
  • chore: updated package.json (f6d65b0)
  • docs: example image (dbb83f8)
  • docs: improved readme (20dc6cd)
  • playground: created playground example (6132606)

Bug Fixes

  • docs: improved readme title (d6d79cb)