@jayesol/jayeson.lib.sports

#### Packaging Structure - Packages are classified into **"levels"**; **each vertical is a level. Veiwed from left to right** - Arrows define dependency. E:g A -> B means A depend on B - Any class can only depend on classes within it's package or classes

Stats

StarsIssuesVersionUpdatedCreatedSize
@jayesol/jayeson.lib.sports
2.2.52 months ago4 years agoMinified + gzip package size for @jayesol/jayeson.lib.sports in KB

Readme

SportsFeed

Packaging Structure

  • Packages are classified into "levels"; each vertical is a level. Veiwed from left to right
  • Arrows define dependency. E:g A -> B means A depend on B
  • Any class can only depend on classes within it's package or classes from packages in previous levels
  • There cannot be any dependency among packages of same level

Package-Info

  • jayeson.lib.sports.protobuf - Classes generated by protobuf
  • jayeson.lib.sports.datastructure - Core datastructure used across all classes
  • jayeson.lib.sports.filter - Abstractions around IDataFilter combined with sport's datastructure
  • jayeson.lib.sports.mutable - Provide Mutable builder's for jayeson.lib.record's datastructure
  • jayeson.lib.sports.util - Static utility functions
  • jayeson.lib.sports.codec - Definition of various message classes and logic to serialize data structure to Protibuf and vice versa
  • jayeson.lib.sports.core - Core components used across whole library
  • jayeson.lib.sports.receive - Implementation of logic to receive data from upstream
  • jayeson.lib.sports.receive.memory - Implementation of logic to receive data in memory(E:g Bot)
  • jayeson.lib.sports.dispatch - Abstractions for pushing received data downstream
  • jayeson.lib.sports.dispatch.relayer - Abstratction to push data without any post-processing
  • jayeson.lib.sports.dispatch.transform - Abstraction and logic to push data with post processing
  • jayeson.lib.sports.dispatch.network - Abstraction and logic to push data via network
  • jayeson.lib.sports.client - Abstrations for end under to consume data
  • jayesib.lib.sports.module - Various module bindings


                     +-------------------------------------------------------------------------------+
                     |                                                                               |
                     |  +-------------+                                                              |
                     |  |   client    +---------------------+                                        v
                     |  +-------------+                     |                                    +-----------+
                     |                              +----+  |                                    | filter    +----------------+
                     |  +---------------------+     |    |  |                                    +-----------+                |
                     +--+  dispatch.transform +-----+    v  v                                                                 v
                        +---------------------+        +-------------+     +----------+                                +-----------------+
                                                    +->| dispatch    +---->|  core    +----+     +-----------+         |  datastructure  |
                        +--------------------+      |  +-------------+     +----------+    |---->| mutable   |         +-----------------+
                        |  dispatch.network  +---+  |          ^                  ^        |     +-----------+                  ^
                        +--------------------+   |  |          |                  |        |                                    |
                                                 +--+          |                  |        |                       +------------+
+-----------------+     +------------------+                   |                  |        |     +-----------+     |
|                 |     | dispatch.relayer +-------------------+                  |        |---->|   util    +-----+---+
|    Module       |     +------------------+                                      |        |     +-----------+     |   |   +-----------------+
+-----------------+                                                               |        |                       |   +-->|     protobuf    |
                                                                                  |        |                       |       +-----------------+
                        +-----------------+            +-------------+            |        |     +-----------+     |
                        | receive.memory  +----------->|   receive   +------------>        +---->|  codec    +-----+
                        +-----------------+            +-------------+                           +-----------+

Message Transformation Flow

Picture show how message gets transformed when they are passed from one component to other

Picture show how message gets transformed when they are passed from one component to other

PS: Drawn using Gliffy. Get source diagram from jayeson's gliffy account

CI/CD guideline

Publish

Guideline: CI/CD guideline

  • Publish for non prod repo:

       publish: snapshot 
    
  • Publish for production repo:

       publish: prod
    

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.