Skip to main content

Module props

Module props 

Source
Expand description

Common property keys shared across node types.

Constants§

ARITY
Arity for languages that care about it (e.g. Erlang).
BASE_URL
Base URL for an external API, e.g. “https://api.vendorx.com”.
CODE_BYTES
Zstd-compressed source snippet (RedCompressor wire format, raw bytes).
FQN
Fully-qualified name for symbols (e.g. module:function/arity or com.example.Class.method).
FRAMEWORK
Web / application framework (e.g. “cowboy”, “spring”).
LANGUAGE
Programming language of the artifact (e.g. “erlang”, “java”).
METHOD
HTTP method(s) for an API endpoint, e.g. GET/POST.
NAME
Simple name (module name, function name, etc.).
OPTIONAL
Whether callback is optional for its behaviour contract.
PARAM_COUNT
Number of parameters the function takes. For Erlang this should match arity; for other languages it is simply the parameter list length.
PARAM_TYPES
Parameter types when they are explicitly written in the source (e.g. Java, C#, Go, TypeScript). Stored as an array of strings.
PATH
Filesystem or project‑relative path.
PATH_TEMPLATE
Canonical path for an API endpoint, e.g. “/omega/api/getavroutes”.
PROJECT_NAME
Logical project or service name (e.g. “omega”).
PROTOCOL
Protocol for the endpoint (e.g. “http”, “https”, “grpc”).
PROVIDER
Logical provider/vendor name for an external API, e.g. “VendorX”.
RETURN_TYPE
Return type of the function when it is explicitly declared (Java, C#, Go, Erlang -spec, etc.). This is optional and may be absent for dynamically-typed or unannotated code.
SERVICE
Logical service domain for an external API, e.g. “payments”, “inventory”, “search”.