Skip to main content
Version: v2

IEnvelope Interface

An envelope wraps the contents with the intended target

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/runtime-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface IEnvelope<TContents = any>

Type Parameters​

ParameterDefaultDescription
TContentsany

Properties​

PropertyAlertsTypeDescription
addressBetastringThe target for the envelope
contentsBetaTContentsThe contents of the envelope

Property Details​

address​

The target for the envelope

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

address: string;

Type: string

contents​

The contents of the envelope

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

contents: TContents;

Type: TContents