estol-blog

estol-blog

estol-blog is a Node.js dependency for managing blog-related operations.

Installation

To use estol-blog in your Node.js project, you can install it using npm:

npm install estol-blog

Usage

Importing and initializing

import { configureBlogDependency, blogController } from 'estol-blog';

// Configure the dependency with your database URL
configureBlogDependency({
  databaseURL: 'your-database-url',
  model: YourPostModel, // Replace YourPostModel with your Mongoose model
});

// Access blogController for various blog management operations
const { getPosts, postManagement } = blogController;

Usage example

Getting posts

const posts = await getPosts({ searchType: 'Last', model: YourPostModel, quantity: 5 });
console.log(posts);

Post management

const newPostData = {
  author: 'John Doe',
  title: 'New Blog Post',
  content: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
};

const createPostResult = await postManagement({ action: 'create', model: YourPostModel, newPost: newPostData });
console.log(createPostResult);

Configuration

estol-blog uses Mongoose for database interactions. Make sure to have Mongoose installed and configured in your project.

API Reference

configureBlogDependency(config)

Configures the estol-blog dependency with the provided configuration.

config: An object containing the configuration options. It should have a databaseURL and optionally a model for the blog posts.

blogController

A set of functions for managing blog-related operations.

getPosts(options) Retrieve blog posts based on specified options.

options: An object containing various options for retrieving posts. postManagement(options) Perform blog post management actions like creating, updating, or deleting posts.

options: An object containing parameters for the desired action.

Licence

This project is licensed under the MIT License - see the LICENSE.md file for details.

Make sure to replace placeholders like `'your-database-url'`, `YourPostModel`, and adjust the code snippets based on your actual implementation and use case.