The HistoryStore tag.
contextHistoryStore
Source src/HistoryStore.ts:554 lines
export class class HistoryStoreTagclass HistoryStoreTag {
key: Identifier;
Service: {
append: (streamId: string, entry: unknown) => Effect.Effect<void>;
read: (streamId: string, options?: HistoryReadOptions) => Effect.Effect<ReadonlyArray<unknown>>;
};
}
The
HistoryStore
tag.
HistoryStoreTag extends import ContextContext.const Service: <HistoryStoreTag, HistoryStoreShape>() => <Identifier, E, R, Args>(id: Identifier, options?: {
readonly make: ((...args: Args) => Effect.Effect<HistoryStoreShape, E, R>) | Effect.Effect<HistoryStoreShape, E, R> | undefined;
} | undefined) => Context.ServiceClass<HistoryStoreTag, Identifier, HistoryStoreShape> & ([unassigned] extends [...] ? unknown : {
...;
}) (+2 overloads)
Creates a Context service key.
When to use
Use when you need to define a context service key for a dependency that must
be provided by the surrounding context.
Details
Call Context.Service("Key") for a function-style key, or use the two-stage
form Context.Service<Self, Shape>()("Key") for class-style service
declarations. The returned key can be yielded as an Effect and passed to
Context.make, Context.add, and the Context getter functions.
Gotchas
The string key is the runtime identity of the service. Reusing the same key
string for unrelated services makes them occupy the same slot in a
Context.
Example (Creating service keys)
import { Context } from "effect"
// Create a simple service
const Database = Context.Service<{
query: (sql: string) => string
}>("Database")
// Create a service class
class Config extends Context.Service<Config, {
port: number
}>()("Config") {}
// Use the services to create contexts
const db = Context.make(Database, {
query: (sql) => `Result: ${sql}`
})
const config = Context.make(Config, { port: 8080 })
Service<
class HistoryStoreTagclass HistoryStoreTag {
key: Identifier;
Service: {
append: (streamId: string, entry: unknown) => Effect.Effect<void>;
read: (streamId: string, options?: HistoryReadOptions) => Effect.Effect<ReadonlyArray<unknown>>;
};
}
The
HistoryStore
tag.
HistoryStoreTag,
HistoryStoreShape
>()("hyperlink-ts/HistoryStore/HistoryStoreTag") {}
Referenced by 1 symbols