https://github.com/agustinsrg/tsbean-driver-template

tsbean-orm driver template
https://github.com/agustinsrg/tsbean-driver-template

driver tsbean tsbean-orm

Last synced: about 1 month ago
JSON representation

tsbean-orm driver template

• Host: GitHub
• URL: https://github.com/agustinsrg/tsbean-driver-template
• Owner: AgustinSRG
• License: mit
• Created: 2021-05-11T14:35:31.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-29T09:44:33.000Z (7 months ago)
• Last Synced: 2024-06-29T10:47:53.212Z (7 months ago)
• Topics: driver, tsbean, tsbean-orm
• Language: TypeScript
• Homepage:
• Size: 342 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TSBean-ORM Driver Template

This is a generic template to create a driver for [tsbean-orm](https://github.com/AgustinSRG/tsbean-orm).

Modify `driver.ts` to implement the driver functionalities depending on the data source this driver supports.

## Installation

```

npm install --save [driver-name-here]

```

## Build the project

To compile the driver type:

```

npm run build

```

The javascript files are stored in the `dist` folder.

The documentation is stored in the `docs` folder.

## Usage

```ts

import { DataSourceDriver, DataSource } from "tsbean-orm";

import { TemplateDriver } from "tsbean-driver-template"

const mySource = TemplateDriver.createDataSource({} /* Options */);

DataSource.set(DataSource.DEFAULT, mySource);

```