mxdocgen/dist/sdk/documenttypes.d.ts

A small tool that mimics the documentation generation capabilities offered in Mendix Studio Pro, but with greater flexibility. It uses the Mendix Model SDK to extract information from a Mendix model, which is then fed into a set of templates to generate

import { appservices, codeactions, constants, datasets, documenttemplates, domainmodels, enumerations, exportmappings, images, importmappings, javaactions, javascriptactions, jsonstructures, mappings, menus, messagedefinitions, microflows, nativepages, pages, projects, regularexpressions, rest, scheduledevents, webservices, xmlschemas } from "mendixmodelsdk";
export declare const documentTypeName: (document: projects.IModuleDocument) => string;
export declare const documentLowerTypeName: (document: projects.IModuleDocument) => string;
export declare const typeName: (documentType: typeof projects.ModuleDocument) => string;
export declare const lowerTypeName: (documentType: typeof projects.ModuleDocument) => string;
export declare const isBuildingBlock: (document: projects.IModuleDocument) => document is pages.BuildingBlock;
export declare const isCodeAction: (document: projects.IModuleDocument) => document is codeactions.CodeAction;
export declare const isConstant: (document: projects.IModuleDocument) => document is constants.Constant;
export declare const isConsumedAppService: (document: projects.IModuleDocument) => document is appservices.ConsumedAppService;
export declare const isConsumedODataService: (document: projects.IModuleDocument) => document is rest.ConsumedODataService;
export declare const isDataSet: (document: projects.IModuleDocument) => document is datasets.DataSet;
export declare const isDocument: (document: projects.IModuleDocument) => document is projects.Document;
export declare const isDocumentTemplate: (document: projects.IModuleDocument) => document is documenttemplates.DocumentTemplate;
export declare const isDomainModel: (document: projects.IModuleDocument) => document is domainmodels.DomainModel;
export declare const isEnumeration: (document: projects.IModuleDocument) => document is enumerations.Enumeration;
export declare const isExportMapping: (document: projects.IModuleDocument) => document is exportmappings.ExportMapping;
export declare const isFormBase: (document: projects.IModuleDocument) => document is pages.FormBase;
export declare const isImageCollection: (document: projects.IModuleDocument) => document is images.ImageCollection;
export declare const isImportMapping: (document: projects.IModuleDocument) => document is importmappings.ImportMapping;
export declare const isImportedWebService: (document: projects.IModuleDocument) => document is webservices.ImportedWebService;
export declare const isJavaAction: (document: projects.IModuleDocument) => document is javaactions.JavaAction;
export declare const isJavaScriptAction: (document: projects.IModuleDocument) => document is javascriptactions.JavaScriptAction;
export declare const isJsonStructure: (document: projects.IModuleDocument) => document is jsonstructures.JsonStructure;
export declare const isLayout: (document: projects.IModuleDocument) => document is pages.Layout;
export declare const isMappingDocument: (document: projects.IModuleDocument) => document is mappings.MappingDocument;
export declare const isMenuDocument: (document: projects.IModuleDocument) => document is menus.MenuDocument;
export declare const isMessageDefinitionCollection: (document: projects.IModuleDocument) => document is messagedefinitions.MessageDefinitionCollection;
export declare const isMicroflow: (document: projects.IModuleDocument) => document is microflows.Microflow;
export declare const isMicroflowBase: (document: projects.IModuleDocument) => document is microflows.MicroflowBase;
export declare const isModuleDocument: (document: projects.IModuleDocument) => document is projects.ModuleDocument;
export declare const isMxSchema: (document: projects.IModuleDocument) => document is xmlschemas.MxSchema;
export declare const isNanoflow: (document: projects.IModuleDocument) => document is microflows.Nanoflow;
export declare const isNativeLayout: (document: projects.IModuleDocument) => document is nativepages.NativeLayout;
export declare const isNativePage: (document: projects.IModuleDocument) => document is nativepages.NativePage;
export declare const isPage: (document: projects.IModuleDocument) => document is pages.Page;
export declare const isPageTemplate: (document: projects.IModuleDocument) => document is pages.PageTemplate;
export declare const isPublishedAppService: (document: projects.IModuleDocument) => document is webservices.PublishedAppService;
export declare const isPublishedODataService: (document: projects.IModuleDocument) => document is rest.PublishedODataService;
export declare const isPublishedRestService: (document: projects.IModuleDocument) => document is rest.PublishedRestService;
export declare const isPublishedServiceBase: (document: projects.IModuleDocument) => document is webservices.PublishedServiceBase;
export declare const isPublishedWebService: (document: projects.IModuleDocument) => document is webservices.PublishedWebService;
export declare const isRegularExpression: (document: projects.IModuleDocument) => document is regularexpressions.RegularExpression;
export declare const isRemoteEntitySourceDocument: (document: projects.IModuleDocument) => document is domainmodels.RemoteEntitySourceDocument;
export declare const isRule: (document: projects.IModuleDocument) => document is microflows.Rule;
export declare const isScheduledEvent: (document: projects.IModuleDocument) => document is scheduledevents.ScheduledEvent;
export declare const isServerSideMicroflow: (document: projects.IModuleDocument) => document is microflows.ServerSideMicroflow;
export declare const isSnippet: (document: projects.IModuleDocument) => document is pages.Snippet;
export declare const isTemplateFormBase: (document: projects.IModuleDocument) => document is pages.TemplateFormBase;
export declare const isXmlSchema: (document: projects.IModuleDocument) => document is xmlschemas.XmlSchema;