@flink-app/flink 0.2.0-beta.17 → 0.2.0-beta.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -4
- package/readme.md +1 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flink-app/flink",
|
|
3
|
-
"version": "0.2.0-beta.
|
|
3
|
+
"version": "0.2.0-beta.18",
|
|
4
4
|
"description": "Typescript only framework for creating REST-like APIs on top of Express and mongodb",
|
|
5
5
|
"types": "dist/src/index.d.ts",
|
|
6
6
|
"main": "dist/src/index.js",
|
|
@@ -9,8 +9,7 @@
|
|
|
9
9
|
"test": "jasmine-ts --preserve-symlinks --config=./spec/support/jasmine.json",
|
|
10
10
|
"test:watch": "nodemon --ext ts --exec 'jasmine-ts --config=./spec/support/jasmine.json'",
|
|
11
11
|
"start": "ts-node src/index.ts",
|
|
12
|
-
"
|
|
13
|
-
"prepublish": "npm run build",
|
|
12
|
+
"prepare": "npm run build",
|
|
14
13
|
"build": "tsc --project tsconfig.dist.json",
|
|
15
14
|
"watch": "nodemon --exec 'tsc --project tsconfig.dist.json'",
|
|
16
15
|
"clean": "rimraf dist"
|
|
@@ -62,5 +61,5 @@
|
|
|
62
61
|
"rimraf": "^3.0.2",
|
|
63
62
|
"ts-node": "^9.1.1"
|
|
64
63
|
},
|
|
65
|
-
"gitHead": "
|
|
64
|
+
"gitHead": "aaeadba35673b13654a54bf752fef3ecc4c94b52"
|
|
66
65
|
}
|
package/readme.md
CHANGED
|
@@ -109,6 +109,7 @@ The following building blocks exists in Flink:
|
|
|
109
109
|
|
|
110
110
|
- Handler - a handler is responsible for handling API requests and return a response. Normally a handler has some type of logic and invokes a _repo_ to CRUD data from database.
|
|
111
111
|
- Repo - a repository is used to abstract data access to database. A repo is used to access a mongo db and a repo is used per collection.
|
|
112
|
+
- Jobs - a piece of code that will be invoked on a schedule or once after app start. Jobs can be cron jobs, migration jobs etc.
|
|
112
113
|
- App Context - the app context is the glue that ties parts of the app together. By defining and creating an app context you make sure that i.e. handlers can get access to repositories.
|
|
113
114
|
- Schemas - models that defines API requests and responses. These are typescript interfaces which will during compile time be converted into JSON schemas used to validate requests and responses and also used to generate API documentation.
|
|
114
115
|
- Flink app - is the entry
|