# bloggify-plugin-class

> A library for managing plugin objects.

Latest version **2.1.3** (published 2020-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install bloggify-plugin-class
pnpm add bloggify-plugin-class
yarn add bloggify-plugin-class
bun add bloggify-plugin-class
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.3 |
| Published | 2020-08-09 |
| First published | 2016-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 14.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Bloggify |
| Maintainers | ionicabizau |
| Keywords | bloggify, plugin, class, a, library, for, managing, objects |

## Links

- npm: https://www.npmjs.com/package/bloggify-plugin-class
- Repository: https://github.com/Bloggify/plugin-class
- Homepage: https://github.com/Bloggify/plugin-class#readme
- Issues: https://github.com/Bloggify/plugin-class/issues
- npm.io page: https://npm.io/package/bloggify-plugin-class

## Dependencies (7)

- [ul](https://npm.io/package/ul.md) ^5.2.1
- [r-json](https://npm.io/package/r-json.md) ^1.2.1
- [assured](https://npm.io/package/assured.md) ^1.0.8
- [same-time](https://npm.io/package/same-time.md) ^2.3.1
- [spawn-npm](https://npm.io/package/spawn-npm.md) ^1.0.0
- [maybe-require](https://npm.io/package/maybe-require.md) ^1.0.0
- [package-json-path](https://npm.io/package/package-json-path.md) ^1.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.1.3 (latest) — 2020-08-09
- 2.1.2 — 2019-01-06
- 2.1.1 — 2019-01-06
- 2.0.1 — 2018-10-19
- 2.0.0 — 2017-08-29
- 1.0.0 — 2016-11-20

## README

<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


















# bloggify-plugin-class

 [![Version](https://img.shields.io/npm/v/bloggify-plugin-class.svg)](https://www.npmjs.com/package/bloggify-plugin-class) [![Downloads](https://img.shields.io/npm/dt/bloggify-plugin-class.svg)](https://www.npmjs.com/package/bloggify-plugin-class)







> A library for managing plugin objects.






This module is used internally in plugin loaders.












## :cloud: Installation

```sh
# Using npm
npm install --save bloggify-plugin-class

# Using yarn
yarn add bloggify-plugin-class
```













## :clipboard: Example



```js
var BloggifyPluginClass = require("bloggify-plugin-class");

// Create a new plugin
var myPlugin = new BloggifyPlugin("foo", "path/to/foo");

// And initialize it
myPlugin.init(function (err, data) {
    // Do something after initialization
    // ...
});
```











## :question: Get Help

There are few ways to get help:



 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
 2. For bug reports and feature requests, open issues. :bug:





## :memo: Documentation


### BloggifyPlugin

Creates a new Bloggify plugin instance.

#### Params

- **String** `name`: The plugin name.
- **String** `pluginPath`: The plugin path.
- **Bloggify** `bloggifyInstance`: The Bloggify instance.

#### Return
- **BloggifyPlugin** The `BloggifyPlugin` instance containing:
 - `name` (String): The plugin's name.
 - `path` (String): The path to the plugin's directory.
 - `packagePath` (String): The path to the plugin's `package.json` file.
 - `bloggify` (Bloggify): The `Bloggify` instance.
 - `config` (Object): The plugin's configuration.

### `getFilePath(fileName)`
Returns the path of the searched file.

#### Params

- **String** `fileName`: The name of the file who's path is being searched.

#### Return
- **String** The file's path.

### `init(cb)`
Initializes the plugin.

#### Params

- **Function** `cb`: The callback function.

### `getConfig()`
Returns plugin's configuration.

#### Return
- **Object** The configuration content.

### `getPackage(cb)`
Returns the plugin's package file.

#### Params

- **Function** `cb`: The callback function.

#### Return
- **Object** The package contents.














## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

 - `bloggify-plugin-loader`











## :scroll: License

[MIT][license] © [Bloggify][website]






[license]: /LICENSE
[website]: https://bloggify.org
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md

---
_Source: https://npm.io/package/bloggify-plugin-class · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._