Matter.Plugin

Modul Matter.Plugin obsahuje funkce pro registraci a instalaci pluginů na moduly.

Metody

Matter.Plugin.dependencies(module) → Object

Rekurzivně najde všechny závislosti modulu a vrátí plochý graf závislostí.

Parametry

• module Object

Návraty

Object: Graf závislosti.

Matter.Plugin.dependencyParse(dependency) → Object

Analyzuje řetězec závislosti na jeho komponenty. Závislost je řetězec ve formátu 'název-modulu' nebo 'název-modulu@verze'. Popis formátu naleznete v dokumentaci k Plugin.versionParse. Tato funkce může také zpracovávat závislosti, které jsou již vyřešeny (např. modulový objekt).

Parametry

• dependency StringZávislost formátu 'název-modulu' nebo 'název-modulu@verze'.

Návraty

Object: Závislost analyzována do jejích komponent.

Matter.Plugin.isFor(plugin, module) → Boolean

Vrátí hodnotu true, pokud je plugin.for použitelný pro modul porovnáním s module.name a module.version. Pokud plugin.for není zadán, předpokládá se, že je použitelný. Hodnota plugin.for je řetězec ve formátu 'název-modulu' nebo 'název-modulu@verze'.

Parametry

• plugin Object
• module Object

Návraty

Boolean: true, pokud je plugin.for použitelný pro modul, jinak false.

Matter.Plugin.isPlugin(obj) → Boolean

Vrátí hodnotu true, pokud objekt splňuje minimální standard, aby mohl být považován za plugin. To znamená, že musí definovat následující vlastnosti:

• název
• verze
• Nainstalujte

Parametry

• obj Object

Návraty

Boolean: true, pokud lze objekt považovat za plugin, jinak je false.

Matter.Plugin.isUsed(module, name) → Boolean

Vrací hodnotu true, pokud byl na modul nainstalován plugin s daným názvem.

Parametry

• module Object
• name String

Návraty

Boolean: true, pokud je na modulu nainstalován plugin s daným názvem, jinak false.

Matter.Plugin.register(plugin) → Object

Registruje objekt pluginu, takže jej lze později vyřešit podle názvu.

Parametry

• plugin Object

Návraty

Object: Plugin.

Matter.Plugin.resolve(dependency) → Object

Vyřeší závislost na objektu pluginu z registru, pokud existuje. Závislost může obsahovat verzi, ale při řešení záleží pouze na názvu.

Parametry

• dependency String

Návraty

Object: Pokud je plugin vyřešen, jinak není definován.

Matter.Plugin.toString(plugin) → String

Vrátí pěkně vytištěný název a verzi pluginu.

Parametry

• plugin Object

Návraty

String: Pěkně vytištěný název a verze pluginu.

Matter.Plugin.use(module, [plugins=module.uses])

Nainstaluje pluginy voláním plugin.install na každý plugin zadaný v pluginech, pokud je předán, jinak module.uses. Pro instalaci zásuvných modulů na Matter se podívejte na komfortní funkci Matter.use. Pluginy mohou být specifikovány buď svým názvem nebo odkazem na objekt pluginu. Samotné pluginy mohou specifikovat další závislosti, ale každý plugin se instaluje pouze jednou. Pořadí je důležité, provádí se topologické řazení pro nalezení nejlepšího výsledného pořadí instalace. Toto třídění se pokouší uspokojit požadované pořadí každé závislosti, ale nemusí být ve všech případech přesné. Tato funkce zaznamenává výsledný stav každé závislosti v konzole spolu s případnými varováními.

• Zelené zaškrtnutí ✅ znamená, že závislost byla vyřešena a nainstalována.
• Oranžový kosočtverec 🔶 znamená, že závislost byla vyřešena, ale bylo pro ni nebo pro její závislosti vyvoláno varování.
• Červený křížek ❌ znamená, že závislost nelze vyřešit. Vyhněte se volání této funkce vícekrát na stejném modulu, pokud nemáte v úmyslu ručně řídit pořadí instalace.

Parametry

• module ObjectModul instaluje pluginy na.
• [plugins=module.uses] Object optionalZásuvné moduly, které se mají nainstalovat na modul (volitelné, výchozí je module.uses).

Matter.Plugin.versionParse(range) → Object

Analyzuje řetězec verze do jeho součástí.

Verze jsou striktně ve formátu x.y.z (jako v semver). Verze mohou mít volitelně značku předběžného vydání ve formátu x.y.z-alpha. Rozsahy jsou striktní podmnožinou rozsahů npm. Podporovány jsou pouze následující typy rozsahů:

• Tilda se pohybuje např. ~1.2.3
• Rozsahy stříšek např. ^1.2.3
• Větší než rozsahy např. >1.2.3
• Větší nebo stejné rozsahy, např. > = 1,2,3
• Přesná verze např. 1.2.3
• Jakákoli verze *

Parametry

• range StringŘetězec verze.

Návraty

Object: Rozsah verzí analyzovaný do jeho součástí.

Matter.Plugin.versionSatisfies(version, range) → Boolean

Vrátí hodnotu true, pokud verze splňuje daný rozsah. Popis formátu naleznete v dokumentaci k Plugin.versionParse. Pokud verze nebo rozsah není zadán, předpokládá se, že vyhovuje jakákoli verze (*).

Parametry

• version String
• range String

Návraty

Boolean: true, pokud verze vyhovuje rozsahu, jinak false.