SocialluxSociallux
Toggle navigation menu
Docs navigationv

Primitive

atom.getDataField

BETA

Short name: getDataField

Version: 1.0.0

System primitive that returns one top-level atom.data field value without requiring full-atom handling in composed verbs.

Back to primitive library

Inputs

KeyTypeRequiredDescription
atomIdobjectIdtrueAtom to read from.
defaultanyfalseOptional fallback value returned when the field is missing (or redacted for this caller).
fieldNamestringtrueTop-level key under atom.data to return.

Outputs

KeyTypeRequiredDescription
existsbooleanfalseTrue when the caller can read the field and it exists on atom.data; false when missing or redacted.
redactedbooleanfalseTrue when the field exists on the underlying atom but is hidden from this caller (e.g. private field with no grant). False otherwise.
valueanyfalseField value when present; otherwise the provided default (or undefined).
valueTypestringfalseDeclared FieldEntry valueType when available; otherwise an inferred runtime type label.