<K extends string, A>(self: ReadonlyRecord<K, A>): numberReturns the number of key/value pairs in a record.
Example (Getting the record size)
import { Record } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Record.size({ a: "a", b: 1, c: true }), 3)getters
Source effect/Record.ts:3831 lines
export const const size: <K extends string, A>(
self: ReadonlyRecord<K, A>
) => number
Returns the number of key/value pairs in a record.
Example (Getting the record size)
import { Record } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Record.size({ a: "a", b: 1, c: true }), 3)
size = <function (type parameter) K in <K extends string, A>(self: ReadonlyRecord<K, A>): numberK extends string, function (type parameter) A in <K extends string, A>(self: ReadonlyRecord<K, A>): numberA>(self: ReadonlyRecord<K, A>self: type ReadonlyRecord<in out K extends string | symbol, out A> = { readonly [P in K]: A; }Represents a readonly record with keys of type K and values of type A.
This is the foundational type for immutable key-value mappings in Effect.
Example (Defining a readonly record type)
import type { Record } from "effect"
// Creating a readonly record type
type UserRecord = Record.ReadonlyRecord<"name" | "age", string | number>
const user: UserRecord = {
name: "John",
age: 30
}
Namespace containing utility types for working with readonly records.
These types help with type-level operations on record keys and values.
Example (Using readonly record helper types)
import type { Record } from "effect"
// Using NonLiteralKey to convert literal keys to generic types
type GenericKey = Record.ReadonlyRecord.NonLiteralKey<"foo" | "bar"> // string
// Using IntersectKeys to find common keys between record types
type CommonKeys = Record.ReadonlyRecord.IntersectKeys<"a" | "b", "b" | "c"> // "b"
ReadonlyRecord<function (type parameter) K in <K extends string, A>(self: ReadonlyRecord<K, A>): numberK, function (type parameter) A in <K extends string, A>(self: ReadonlyRecord<K, A>): numberA>): number => const keys: <
K extends string | symbol,
A
>(
self: ReadonlyRecord<K, A>
) => Array<K & string>
Retrieves the keys of a given record as an array.
Example (Getting record keys)
import { Record } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(Record.keys({ a: 1, b: 2, c: 3 }), ["a", "b", "c"])
keys(self: ReadonlyRecord<K, A>self).Array<T>.length: numberGets or sets the length of the array. This is a number one higher than the highest index in the array.
length