From 180f51a012bacc396af66ad8e0f0aae5fa2c6c93 Mon Sep 17 00:00:00 2001 From: Ldoppea Date: Mon, 23 Sep 2024 18:57:47 +0200 Subject: [PATCH] docs: Update types and documentation --- docs/api/cozy-client/README.md | 2 +- docs/api/cozy-client/classes/CozyLink.md | 2 +- .../{FlagshipLink.md => WebFlagshipLink.md} | 20 +++++++++---------- ...FlagshipLink.d.ts => WebFlagshipLink.d.ts} | 2 +- packages/cozy-client/types/index.d.ts | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) rename docs/api/cozy-client/classes/{FlagshipLink.md => WebFlagshipLink.md} (60%) rename packages/cozy-client/types/{FlagshipLink.d.ts => WebFlagshipLink.d.ts} (87%) diff --git a/docs/api/cozy-client/README.md b/docs/api/cozy-client/README.md index bb806e46c..e42610680 100644 --- a/docs/api/cozy-client/README.md +++ b/docs/api/cozy-client/README.md @@ -16,7 +16,6 @@ cozy-client * [CozyClient](classes/CozyClient.md) * [CozyLink](classes/CozyLink.md) * [CozyProvider](classes/CozyProvider.md) -* [FlagshipLink](classes/FlagshipLink.md) * [HasMany](classes/HasMany.md) * [HasManyInPlace](classes/HasManyInPlace.md) * [HasManyTriggers](classes/HasManyTriggers.md) @@ -29,6 +28,7 @@ cozy-client * [QueryDefinition](classes/QueryDefinition.md) * [Registry](classes/Registry.md) * [StackLink](classes/StackLink.md) +* [WebFlagshipLink](classes/WebFlagshipLink.md) ## Properties diff --git a/docs/api/cozy-client/classes/CozyLink.md b/docs/api/cozy-client/classes/CozyLink.md index 1a4fa2f4a..9c8abfae5 100644 --- a/docs/api/cozy-client/classes/CozyLink.md +++ b/docs/api/cozy-client/classes/CozyLink.md @@ -8,7 +8,7 @@ ↳ [`StackLink`](StackLink.md) - ↳ [`FlagshipLink`](FlagshipLink.md) + ↳ [`WebFlagshipLink`](WebFlagshipLink.md) ## Constructors diff --git a/docs/api/cozy-client/classes/FlagshipLink.md b/docs/api/cozy-client/classes/WebFlagshipLink.md similarity index 60% rename from docs/api/cozy-client/classes/FlagshipLink.md rename to docs/api/cozy-client/classes/WebFlagshipLink.md index 1ea0f0a62..b405fc2b3 100644 --- a/docs/api/cozy-client/classes/FlagshipLink.md +++ b/docs/api/cozy-client/classes/WebFlagshipLink.md @@ -1,18 +1,18 @@ -[cozy-client](../README.md) / FlagshipLink +[cozy-client](../README.md) / WebFlagshipLink -# Class: FlagshipLink +# Class: WebFlagshipLink ## Hierarchy * [`CozyLink`](CozyLink.md) - ↳ **`FlagshipLink`** + ↳ **`WebFlagshipLink`** ## Constructors ### constructor -• **new FlagshipLink**(`[options]?`) +• **new WebFlagshipLink**(`[options]?`) *Parameters* @@ -27,7 +27,7 @@ *Defined in* -[packages/cozy-client/src/FlagshipLink.js:8](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L8) +[packages/cozy-client/src/WebFlagshipLink.js:8](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/WebFlagshipLink.js#L8) ## Properties @@ -37,7 +37,7 @@ *Defined in* -[packages/cozy-client/src/FlagshipLink.js:10](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L10) +[packages/cozy-client/src/WebFlagshipLink.js:10](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/WebFlagshipLink.js#L10) ## Methods @@ -64,7 +64,7 @@ Persist the given data into the links storage *Defined in* -[packages/cozy-client/src/FlagshipLink.js:25](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L25) +[packages/cozy-client/src/WebFlagshipLink.js:25](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/WebFlagshipLink.js#L25) *** @@ -84,7 +84,7 @@ Persist the given data into the links storage *Defined in* -[packages/cozy-client/src/FlagshipLink.js:13](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L13) +[packages/cozy-client/src/WebFlagshipLink.js:13](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/WebFlagshipLink.js#L13) *** @@ -112,7 +112,7 @@ Request the given operation from the link *Defined in* -[packages/cozy-client/src/FlagshipLink.js:21](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L21) +[packages/cozy-client/src/WebFlagshipLink.js:21](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/WebFlagshipLink.js#L21) *** @@ -132,4 +132,4 @@ Reset the link data *Defined in* -[packages/cozy-client/src/FlagshipLink.js:17](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L17) +[packages/cozy-client/src/WebFlagshipLink.js:17](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/WebFlagshipLink.js#L17) diff --git a/packages/cozy-client/types/FlagshipLink.d.ts b/packages/cozy-client/types/WebFlagshipLink.d.ts similarity index 87% rename from packages/cozy-client/types/FlagshipLink.d.ts rename to packages/cozy-client/types/WebFlagshipLink.d.ts index a54035c3b..f69ec81d1 100644 --- a/packages/cozy-client/types/FlagshipLink.d.ts +++ b/packages/cozy-client/types/WebFlagshipLink.d.ts @@ -1,4 +1,4 @@ -export default class FlagshipLink extends CozyLink { +export default class WebFlagshipLink extends CozyLink { /** * @param {object} [options] - Options * @param {import('cozy-intent').WebviewService} [options.webviewIntent] - The webview's intent reference diff --git a/packages/cozy-client/types/index.d.ts b/packages/cozy-client/types/index.d.ts index 198ff8e3f..763bef556 100644 --- a/packages/cozy-client/types/index.d.ts +++ b/packages/cozy-client/types/index.d.ts @@ -1,7 +1,7 @@ export { default } from "./CozyClient"; export { default as CozyLink } from "./CozyLink"; export { default as StackLink } from "./StackLink"; -export { default as FlagshipLink } from "./FlagshipLink"; +export { default as WebFlagshipLink } from "./WebFlagshipLink"; export { default as compose } from "lodash/flow"; export { default as Registry } from "./registry"; export { default as RealTimeQueries } from "./RealTimeQueries";