CmpInterfaceSuiteOptions | @combeenation/custom-js-utils

Additional options for importing interface objects

Hierarchy

CmpInterfaceSuiteOptions

Index

Properties

mappings
namePostfix
namePrefix

Properties

Optional mappings

mappings: ITypeSuite | {}

Assign specific names to an interface of the suite.

These are registered without any modification by other options.

example

// Component `Shelves` and `Cabinets` should use the same interface `Furniture`
CmpUtils.registerInterfaceSuite(HiveItfs, {
  mappings: {
    Shelves: HiveItfs.Furniture,
    Cabinets: HiveItfs.Furniture,
  }
});

Optional namePostfix

namePostfix: string

Match interface to cmp by removing the given Postfix from the interface-name

example: Itf -> Interface ItfProduct will be mapped to cmp Product

Optional namePrefix

namePrefix: string

Match interface to cmp by removing the given Prefix from the interface-name

example: Record -> Interface ProductRecord will be mapped to cmp Product