Interfaces

Title	Description
Root	Inserts 'root' route into the note
Spot	Describes an enhanced route
Note	Describes a route note
Unit	Describes a processed routes
Units	Describes a bunch of units
Connector	Describes not connected (unprocessed) unit
Connectors	Describes a bunch of connectors
privateNotesKey	Describes a possible key value
PrivateNotesKey	Describes additional (optional) key prop
DefaultNameOptions	Describes route name options (root and wildcard)
CreatorOptionArgs	Describes possible option args in creator functions

Root

Generic Type:

<C = {}>

Keys	Type	Optional
root	RootNote (internal interface)	+

Declares a type which describes defaultroot route

Usage example:

export interface AboutNotes extends Root {
    person: Note;
}

// or if there is only one 'root' path

export type AboutNotes = Root;

Spot

Keys	Type	Optional
id	number
parentId	number
state	string[]
name	string
path	string

Note

Generic Type:

<C = {}>

Keys	Type	Optional
path	string
name	string	+
children	Notes<C>	+

Usage example:

export interface AppNotes {
    root: Note<ChildNotes>
    location: Note;
};

Unit

Generic Type:

<R = any, C = {}>

Keys	Type	Optional
key in keyof (R & C)	Spot & PrivateNotesKey

Usage example:

export const appUnit: Unit<AppNotes, AppChildNotes> = 
    createRoot<AppNotes, AppChildNotes>(routes);

Units

Generic Type:

<R = any>

Keys	Type	Optional
key in keyof R	Unit<R[key]>

Usage example:

export interface Hub {
  app: AppNotes & AppChildNotes;
  about: AboutNotes;
}

export const hub: Units<Hub> = getRegisteredUnits<Hub>();

Connector

Generic Type:

<R = any, C = any>

Type:

(
  parentStructure: Structure,
  alternativeName?: string
) => Unit<R, C>;

Usage example:

export const aboutConnector: Connector<AboutNotes, AboutChildNotes> = 
    createFeature<AboutNotes, AboutChildNotes>(aboutRoutes);

Connectors

Generic Type:

<R = any>

Keys	Type	Optional
key in keyof R	Connector<R[key]>

Usage example:

createRoot(appRoutes, { 
  /**
  * nearby prop accepts connectors
  */
  nearby: {
    location: locationConnector
  }
});

privateNotesKey

describes the private key value

Type:

string | symbol;

PrivateNotesKey

extends interfaces by private key property

Keys	Type	Optional
_key	privateNotesKey

DefaultNameOptions

provides an opportunity to change the default route names for some paths

Keys	Type	Optional
root	string	+
wildcard	string	+

Usage example:

createRoot(routes, {
    routeName: { 
        root: 'home',
        wildcard: 'notFound'
    } 
  }
);

CreatorOptionArgs

describes possible options of root/feature creators

Keys	Type	Optional
key	privateNotesKey
routeName	DefaultNameOptions
nearby	Connectors