Skip to main content
Version: Next (2.x)

FederationPluginOptions<Version>

Options for the federation plugin. All options are optional and have sensible defaults, so you can just call federationPlugin() without any arguments for a good out-of-the-box experience.

Type Parameters​

Type ParameterDefault type

Version extends FederationVersion

DefaultFederationVersion

Properties​

PropertyTypeDefault valueDescription

include?

Exclude<FederationDirectiveNamesByVersion<Version>, "@key" | "@requires" | "@provides" | "@external" | "@extends">[] | "all"

 
['@key', '@external', '@requires', '@provides', '@extends']

Directives to include in the generated federation module. Can be either a list of directive names or 'all' to include all available directives for the specified version.

moduleName?

string

 
'baeta-federation'

Custom name for the federation module

version?

Version

 
'2.9'

Federation version to target. Determines which directives are available for import.