Home > @microsoft/api-extractor-model > ApiOptionalMixin > isOptional

ApiOptionalMixin.isOptional property

True if this is an optional property.

Signature:

readonly isOptional: boolean;

Remarks

For example:

interface X {
  y: string;   // not optional
  z?: string;  // optional
}