<A>(u: Iterable<A>): u is Chunk<A>
(u: unknown): u is Chunk<unknown>Checks whether u is a Chunk<unknown>
Example (Checking for chunks)
import { Chunk } from "effect"
const chunk = Chunk.make(1, 2, 3)
const array = [1, 2, 3]
console.log(Chunk.isChunk(chunk)) // true
console.log(Chunk.isChunk(array)) // false
console.log(Chunk.isChunk("string")) // falseexport const const isChunk: {
<A>(u: Iterable<A>): u is Chunk<A>
(u: unknown): u is Chunk<unknown>
}
Checks whether u is a Chunk<unknown>
Example (Checking for chunks)
import { Chunk } from "effect"
const chunk = Chunk.make(1, 2, 3)
const array = [1, 2, 3]
console.log(Chunk.isChunk(chunk)) // true
console.log(Chunk.isChunk(array)) // false
console.log(Chunk.isChunk("string")) // false
isChunk: {
<function (type parameter) A in <A>(u: Iterable<A>): u is Chunk<A>A>(u: Iterable<A>u: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) A in <A>(u: Iterable<A>): u is Chunk<A>A>): u: Iterable<A>u is interface Chunk<out A>A Chunk is an immutable, ordered collection optimized for efficient concatenation and access patterns.
Example (Inspecting chunk values)
import { Chunk } from "effect"
const chunk: Chunk.Chunk<number> = Chunk.make(1, 2, 3)
console.log(chunk.length) // 3
console.log(Chunk.toArray(chunk)) // [1, 2, 3]
A namespace containing utility types for Chunk operations.
Example (Working with Chunk utility types)
import type { Chunk } from "effect"
// Extract the element type from a Chunk
declare const chunk: Chunk.Chunk<string>
type ElementType = Chunk.Chunk.Infer<typeof chunk> // string
// Create a preserving non-emptiness
declare const nonEmptyChunk: Chunk.NonEmptyChunk<number>
type WithString = Chunk.Chunk.With<typeof nonEmptyChunk, string> // Chunk.NonEmptyChunk<string>
Chunk<function (type parameter) A in <A>(u: Iterable<A>): u is Chunk<A>A>
(u: unknownu: unknown): u: unknownu is interface Chunk<out A>A Chunk is an immutable, ordered collection optimized for efficient concatenation and access patterns.
Example (Inspecting chunk values)
import { Chunk } from "effect"
const chunk: Chunk.Chunk<number> = Chunk.make(1, 2, 3)
console.log(chunk.length) // 3
console.log(Chunk.toArray(chunk)) // [1, 2, 3]
A namespace containing utility types for Chunk operations.
Example (Working with Chunk utility types)
import type { Chunk } from "effect"
// Extract the element type from a Chunk
declare const chunk: Chunk.Chunk<string>
type ElementType = Chunk.Chunk.Infer<typeof chunk> // string
// Create a preserving non-emptiness
declare const nonEmptyChunk: Chunk.NonEmptyChunk<number>
type WithString = Chunk.Chunk.With<typeof nonEmptyChunk, string> // Chunk.NonEmptyChunk<string>
Chunk<unknown>
} = (u: unknownu: unknown): u: unknownu is interface Chunk<out A>A Chunk is an immutable, ordered collection optimized for efficient concatenation and access patterns.
Example (Inspecting chunk values)
import { Chunk } from "effect"
const chunk: Chunk.Chunk<number> = Chunk.make(1, 2, 3)
console.log(chunk.length) // 3
console.log(Chunk.toArray(chunk)) // [1, 2, 3]
A namespace containing utility types for Chunk operations.
Example (Working with Chunk utility types)
import type { Chunk } from "effect"
// Extract the element type from a Chunk
declare const chunk: Chunk.Chunk<string>
type ElementType = Chunk.Chunk.Infer<typeof chunk> // string
// Create a preserving non-emptiness
declare const nonEmptyChunk: Chunk.NonEmptyChunk<number>
type WithString = Chunk.Chunk.With<typeof nonEmptyChunk, string> // Chunk.NonEmptyChunk<string>
Chunk<unknown> => hasProperty<"~effect/collections/Chunk">(self: unknown, property: "~effect/collections/Chunk"): self is { [K in "~effect/collections/Chunk"]: unknown; } (+1 overload)Checks whether a value has a given property key.
When to use
Use when you need a Predicate guard for property access on unknown
values with a simple structural object check.
Details
Uses the in operator and isObjectKeyword. This does not check property
value types.
Example (Guarding object properties)
import { Predicate } from "effect"
const hasName = Predicate.hasProperty("name")
const data: unknown = { name: "Ada" }
if (hasName(data)) {
console.log(data.name)
}
hasProperty(u: unknownu, const TypeId: "~effect/collections/Chunk"TypeId)