@rbxts/rlog/out/enrichers/function-tag-enricher.d.ts

Context-based server-side logging solution for ROBLOX projects.

/**
 * @license
 * Copyright 2024 Daymon Littrell-Reyes
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { LogEntry } from "../common";
/**
 * Enricher for adding a tag to a log matching the function name, if absent.
 *
 * @remarks
 *
 * If the entry doesn't have a tag, then this enricher will use the
 * {@link SourceMetadata.nearest_function_name | nearest_function_name} of where log occurred instead.
 *
 * @example
 * ```ts
 * const logger = new RLog({ enrichers: [functionTagEnricher] });
 *
 * function CoolFunction() {
 *  logger.i("Hello world!");
 * }
 *
 * CoolFunction();
 * // > [INFO]: CoolFunction -> Hello world!
 * ```
 *
 * @public
 */
export declare function functionTagEnricher(entry: LogEntry): LogEntry;
//# sourceMappingURL=function-tag-enricher.d.ts.map