@alekswilc/ray (1.0.1)

2024-08-03T02:09:33+02:00

Setup this registry in your project .npmrc file:

@alekswilc:registry=

To install the package using npm, run the following command:

npm install @alekswilc/ray@1.0.1

or add it to the package.json file:

"@alekswilc/ray": "1.0.1"

For more information on the npm registry, see the documentation.

@alekswilc/ray

Lightweight & fast ray integration library written in typescript

Supports ESM and CommonJS
Provides standalone bundle
Supports node 16+
Simple usage

Install

npm config set @alekswilc:registry=https://git.alekswilc.dev/api/packages/alekswilc/npm/
npm i @alekswilc/ray

Performance

3 requests took avg 28ms.
avg 2Mb memory usage on request

Env configuration

ALEKSRAY_URI (default: http://localhost:23517/)
ALEKSRAY_DISABLED (default: null)

Methods

/* COLORS */
import { ray } from '@alekswilc/ray';
ray("Message").green();
ray("Message").orange();
ray("Message").red();
ray("Message").purple();
ray("Message").blue();
ray("Message").gray();
ray("Message").color('red');

/* LOGGER */
ray().log("Message")
ray().info("Message")
ray().debug("Message")
ray().warn("Message")
ray().error("Message")
ray().error(new Error("Message"))


/* FORMATS */
ray().label('TEST'); // set label
ray().separator(); // display separator
ray().raw({"test"}); // raw log
ray().json({"test"}); // display json
ray().pretty(["test"]) // display using pretty-format
ray().send("data") // alias to ray("data")
await ray().pause() // break point [ASYNC FUNCTION]


/* SET CUSTOM ORIGIN */
ray().customOrigin({ function_name: "test", file: "test.js", line_number: 1, hostname: "aleks-desktop" }).send("test")

/* CHAINING */
ray('test').color('red').label('test2')

Used dependencies

License

The MIT License (MIT). Please see License File for more information.

Credits

Permafrost Development (node-ray under The MIT License)

Dependencies

ID	Version
@permafrost-dev/pretty-format	^1.1.5
stacktrace-js	^2.0.2
uuid	^10.0.0

Development Dependencies

ID	Version
@types/node	^20.14.2
@types/uuid	^9.0.8
dts-bundle-generator	^9.5.1
esbuild	^0.21.5
fast-glob	^3.3.2
typescript	^5.4.5

Details

npm

alekswilc/ray

2024-08-03 02:09:33 +02:00

14

alekswilc

ISC

latest

155 KiB

Assets (1)

ray-1.0.1.tgz 155 KiB

Versions (2) View all

1.0.1

2024-08-03

1.0.0