🤖 Merge PR DefinitelyTyped#72226 [splunk-logging] add Severity levels enum to types by @dhensby

Author: dhensby

types/splunk-logging/index.d.ts

@@ -1,5 +1,12 @@
 import { CoreOptions as RequestOptions } from "request";
 
+export enum Severity {
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error",
+}
+
 export interface Config {
     token: string;
     name?: string | undefined;
@@ -9,7 +16,7 @@ export interface Config {
     protocol?: "http" | "https" | undefined;
     port?: number | undefined;
     url?: string | undefined;
-    level?: string | undefined;
+    level?: Severity | string | undefined;
     batchInterval?: number | undefined;
     maxBatchSize?: number | undefined;
     maxBatchCount?: number | undefined;
@@ -25,7 +32,7 @@ export interface SendContextMetadata {
 
 export interface SendContext {
     message: any;
-    severity?: string | undefined;
+    severity?: Severity | string | undefined;
     metadata?: SendContextMetadata | undefined;
 }
 
@@ -37,6 +44,7 @@ export class Logger {
     eventFormatter: EventFormatter;
     requestOptions: RequestOptions;
     readonly serializedContextQueue: any[];
+    readonly levels: typeof Severity;
 
     constructor(config: Config);
 

types/splunk-logging/splunk-logging-tests.ts

@@ -1,4 +1,4 @@
-import { Logger } from "splunk-logging";
+import { Logger, Severity } from "splunk-logging";
 
 const config = {
     token: "your-token-here",
@@ -28,7 +28,7 @@ logger.send(payload, (err, resp, body) => {
 
 const fullPayload = {
     message: [1, 2, 3],
-    severity: "error",
+    severity: logger.levels.ERROR,
     metadata: {
         host: "myHost",
         index: "splunkIndex",
@@ -48,7 +48,7 @@ const fullConfig = {
     path: "splunkPath",
     procotol: "https",
     port: 2,
-    level: "info",
+    level: Severity.INFO,
     batchInterval: 3,
     maxBatchSize: 4,
     maxBatchCount: 5,