@quenty/brio

Brio

Brios wrap a value and provide the following constraints

Installation

npm install @quenty/brio --save

• Can be in 2 states, dead or alive
• While alive, can retrieve values
• While dead, retrieving values is forbidden
• Died will fire once upon death

Brios encapsulate the "lifetime" of a valid resource. Unlike a maid, they

• Can only die once
• Have less memory leaks
• Cannot be reentered

Calling :Destroy() or :Kill() after death does nothing. Brios cannot be resurrected.

Useful for downstream events where you want to emit a resource. Typically brios should be killed when their source is killed.

Brios are intended to be merged with downstream brios so create a chain of reliable resources.

Anything may "kill" a brio by calling :Destroy() or :Kill().

Design philosophy

Brios are designed to solve this issue where we emit an object with a lifetime associated with it from an Observable stream. This resource is only valid for some amount of time (for example, while the object is in the Roblox data model).

In order to know how long we can keep this object/use it, we wrap the object with a Brio, which denotes the lifetime of the object.

Modeling this with pure observables is very tricky because the subscriber will have to also monitor/emit a similar object with less clear conventions. For example an observable that emits the object, and then nil on death.

API Surface

Brio.isBrio(value)

Brio.new(...) -- Wrap

Brio:GetDiedSignal()

Brio:IsDead()

Brio:ErrorIfDead()

Brio:ToMaid()

Brio:GetValue()

Brio:Destroy()