Skip to content

OPSreturn v1.00.00

Latest

Choose a tag to compare

@github-actions github-actions released this 17 Apr 22:59
· 66 commits to main since this release
4170676

πŸ”„ OPSreturn β€” Operation Status Return Module

Version: v1.00.00
Tag: opsreturn-v1.00.00

OPSreturn provides a unified, structured return contract for all PowerShell functions.
Every function returns a consistent PSCustomObject with status code, message, source,
timestamp and optional data payload β€” making error handling and logging predictable
across entire automation projects.


πŸ“₯ Download

πŸ“¦ OPSreturn-v1.00.00.zip

The archive contains the complete OPSreturn module folder, ready to be
placed in any directory on your $env:PSModulePath.


βš™οΈ System Requirements

Requirement Minimum
PowerShell 5.1 or higher (Desktop + Core)
OS Windows 10 / 11
Privileges No administrator rights required

πŸš€ Quick Install

# 1. Extract the ZIP archive
# 2. Copy the OPSreturn folder to your module path, e.g.:
Copy-Item -Path ".\OPSreturn" -Destination "$HOME\Documents\PowerShell\Modules\OPSreturn" -Recurse

# 3. Import and configure
Import-Module OPSreturn
SetCoreConfig -ModuleName 'MyModule' -EnableLogging $true

# 4. Use in your functions
function Do-Something {
    # ... your logic ...
    return OPSsuccess -message 'Operation completed' -data $result
}

πŸ”„ Return Object Structure

Field Type Description
status Int32 Numeric status code (see table below)
code String Human-readable status name (e.g. OPS_SUCCESS)
message String Descriptive status message
source String Caller function name (auto-resolved via CallStack)
timecode String Timestamp of the return event
data Object Optional payload (any type)
logentry String Pre-formatted log line for direct logging

πŸ“Š Status Codes

Function Code Name Value
OPSsuccess OPS_SUCCESS 1000
OPSinfo OPS_INFO 1100
OPSdebug OPS_DEBUG 1200
OPStimeout OPS_TIMEOUT 2000
OPSwarn OPS_WARN 3000
OPSfail OPS_FAIL 4000
OPSerror OPS_ERROR 5000
OPScritical OPS_CRITICAL 6000
OPSfatal OPS_FATAL 7000

This release was created manually via GitHub Actions by praetoriani}.