Struct typescript_type_def::type_expr::ObjectField

pub struct ObjectField {
    pub docs: Option<Docs>,
    pub name: TypeString,
    pub optional: bool,
    pub type: TypeExpr,
}

A field of a TypeScript object type.

Fields

docs: Option<Docs>

The documentation for this field.

name: TypeString

The name of this field.

optional: bool

Whether this field is optional or not.

This corresponds with the ? suffix on the field name which makes it valid to omit the field entirely from the object, effectively giving it a value of undefined. In JSON, omitted optional fields are omitted from the object serialization.

type: TypeExpr

The type of this field.

Trait Implementations

impl Clone for ObjectField

fn clone(&self) -> ObjectField

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObjectField

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for ObjectField