@decaf-ts/for-http 0.2.10 → 0.2.12

package/README.md

@@ -1,10 +1,9 @@
-![Banner](./assets/Banner.png)
+![Banner](./workdocs/assets/decaf-logo.svg)
 
 # decaf-ts/for-http
 
 A lightweight HTTP adapter layer for decaf-ts that enables CRUD-style repositories and services over REST APIs. It defines a generic HttpAdapter with concrete implementations (e.g., Axios), a RestService for simple model-centric operations, and a RestRepository when you need repository decoration logic before submitting to the backend. Includes minimal types for configuration and request flags.
 
-
 ![Licence](https://img.shields.io/github/license/decaf-ts/for-http.svg?style=plastic)
 ![GitHub language count](https://img.shields.io/github/languages/count/decaf-ts/for-http?style=plastic)
 ![GitHub top language](https://img.shields.io/github/languages/top/decaf-ts/for-http?style=plastic)
@@ -28,6 +27,9 @@ A lightweight HTTP adapter layer for decaf-ts that enables CRUD-style repositori
 
 Documentation available [here](https://decaf-ts.github.io/for-http/)
 
+Minimal size: 1.7 KB kb gzipped
+
+
 # decaf-ts/for-http — Detailed Description
 
 This package provides a small, focused HTTP integration for decaf-ts. It introduces a generic HttpAdapter abstraction that maps REST semantics (create/read/update/delete and bulk variants) onto decaf-ts repositories and services, plus minimal configuration and flags. A ready-to-use Axios adapter is included.
@@ -305,6 +307,24 @@ const f: AxiosFlags = { headers: { "X-Trace": "1" } };
 ```
 
 
+## Coding Principles
+
+- group similar functionality in folders (analog to namespaces but without any namespace declaration)
+- one class per file;
+- one interface per file (unless interface is just used as a type);
+- group types as other interfaces in a types.ts file per folder;
+- group constants or enums in a constants.ts file per folder;
+- group decorators in a decorators.ts file per folder;
+- always import from the specific file, never from a folder or index file (exceptions for dependencies on other packages);
+- prefer the usage of established design patters where applicable:
+  - Singleton (can be an anti-pattern. use with care);
+  - factory;
+  - observer;
+  - strategy;
+  - builder;
+  - etc;
+
+
 ### Related
 
 [![decaf-ts](https://github-readme-stats.vercel.app/api/pin/?username=decaf-ts&repo=decaf-ts)](https://github.com/decaf-ts/decaf-ts)
@@ -347,4 +367,4 @@ So if you can, if this project in any way. either by learning something or simpl
 
 This project is released under the [MIT License](./LICENSE.md).
 
-By developers, for developers...
+By developers, for developers...