import * as mandarinets from "https://deno.land/x/mandarinets@v2.3.2/main-core/Mandarine.ns.ts";
Namespaces
This namespace contains all the essentials for mandarine to work Gnerally, global functionings are added to this namespace in order to be easily accesible across Mandarine | |
Refers to the Application Context. The application context is used to manipulate elemental behaviors of Mandarine It is a singleton class | |
Contains the different properties different stereotypes/components take | |
Contains the default information Mandarine needs to work. | |
Handles the interaction with the global environment of Mandarine Mandarine uses a global environment to store and manipulate essential information to work | |
Refers to all the elements part of the core. |
Classes
Class responsible for storing resource handlers | |
Enums
List of all recognizable mandarine components. | |
List of all native components by Mandarine | |
Variables
Used to verify that a method is async | |
Functions
Get the Components' registry from Mandarine's global environment | |
Get the entity manager to manipulate the current DB connection | |
Get the properties mandarine is using. If no properties are set by the user then it gets the default properties. | |
Read .env file located under the current working directory and adds its values to Deno.env | |
Get the global environment based on interface @MandarineGlobalInterface | |
Get the properties (MandarineJsonProperties) from | |
Get the list of registered middlewares Middleware are added to the global environment in order to not request the DI container every time there is an HTTP Request | |
Get the resource handler registry for incoming requests. | |
Get the instance of the Session Container | |
Get the entity manager to manipulate the current DB connection | |
Initializes the Session Container. The session container is used to determine the configuration of Mandarine's sessions | |
Initializes Mandarine Global Environment. | |
Initializes the middleware list in the global environment. | |
Initializes the middleware list in the global environment. | |
Initializes the core modules of Mandarine's security core. | |
Set a new configuration for the mandarine properties If properties are ignored, it will set the default values. |
Interfaces
Stats/Metadata of Mandarine's core. This includes information such as: When Mandarine was started, number of templates, controller, and others. | |
Interface used by the | |
Interface that provides with the necessary fields for | |
Interface that provides with the necessary fields for | |
${MY_VAR} will be considered an environmental reference. The environmental reference will be parsed by CommonUtils.getEnvironmentalReferences and CommonUtils.getEnvironmentalReferences will return an array of EnvironmentalReference | |
Contains all the Global objects that Mandarine uses | |
Refers to the essentials of a component class for the Mandarine Engine. | |
Contains the metadata information of the component. This information is initialized when a component decorator is used | |
Refers to the context of the component inside the DI container. When a request is made to the DI container, this is what the request returns. | |
Refers to the Components' Registry The components' registry is used to communicate the mandarine engine & DI layer This is possibly the most important class for mandarine to work. All components are registered inside this class | |
Handlers the information of a resource handler that will be processed. | |
Refers to the resource handler registry. All the resource handlers either initialized by the user or by Mandarine will be located here. | |
Refers to the templates' registry. All the templates that are read and initialized at mandarine compile time are registed inside the templates registry When an user requests a renderable endpoint, the templates' registry will get requested in order to get the template. | |
List of necessary fields for a Native Component | |
Properties used by the native components registry. This interface provides mandarine with the management of native components in the core. | |
Structure for mandarine.json If mandarine.json is present, some behaviors of the Mandarine starter can be altered such as the location of the properties.json file | |
Structure of Mandarine Properties. Mandarine uses these properties to determine how it should work Custom Properties must extend Mandarine.Properties |