@ayana/bento

Bento

Documentation

Bento is a NodeJS framework designed to make creating and maintaing complex projects a simple and fast process.

What does Bento do:

• Component lifecycle state and management
• Provides consistent API for all components
• Config Loading API
• Event API
• Defines strict, opinionated, rules

What is a Bento Component?

Bento indroduces a concept of components. Components are logical chunks of code that all work together to provide your application to the world.

Components should not take on more then required. (IE: instead of having one component for connecting to Discord and processing messages. Have two, one for the connection and one that handles messages)

How to use Bento (IN-PROGRESS)

Using bento is pretty simple. First import and initilize bento and any plugins you wish to use. Then simply add plugins to bento

'use strict';

import * as path from 'path';

import { Bento, FSComponentLoader } from '@ayana/bento';

// Create a Bento instance
const bento = new Bento();

// Create FSComponentLoader
// NOTE: Keep in mind all FSComponentLoader does is find Bento components in the path provided
// Instantiates them and calls bento.addPrimaryComponent or bento.addSecondaryComponent
// Behind the scenes
const loader = new FSComponentLoader({
	primary: path.resolve(__dirname, 'modules'),
});

// Apply plugin to Bento.
// NOTE: Keep in mind that addPlugin is async and you should .catch any errors
bento.addPlugin(loader).catch(e => {
	console.log('Sad day', e);
});