1.0.3 • Published 6 years ago

tiny-url-mongoose-express v1.0.3

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

TinyUrl-mongoose-express

install size Greenkeeper badge FlowType compatible

This is a simple shortening link, based on Mongoose and Express

Requirements

API

tinyUrlRouter()

tinyUrlRouter(): Router;

TinyUrl

TinyUrl: MongooseModel;

TinyUrlSchema

TinyUrlSchema: MongooseSchema;

{
  _id: number; // start at 100
  url: string; // canonical URL
  createdAt: ?Date; // created automatically
  encodedId: string;
}

How to use

Step 1

yarn add tiny-url-mongoose-express

Step 2

In the schema folder, you need to connect your database. Then connect the router to your Express routing.

// schema
import { TinyUrl } from 'tiny-url-mongoose-express'
// server

import { tinyUrlRouter } from 'tiny-url-mongoose-express';
//
const router = expess.Router();
router.use('/u', tinyUrlRouter());
//

Step 3

Create records in Mongo and use!

TinyUrl.create({ url: 'example.com/hello' });