The AbortSignal interface represents a signal object that allows you to communicate with a DOM request (such as a fetch request) and abort it if required via an AbortController object.
-Generated using TypeDoc
The AbortSignal interface represents a signal object that allows you to communicate with a DOM request (such as a fetch request) and abort it if required via an AbortController object.
+Abstract Protected environmentsProtected exitProtected failProtected initProtected parseOptional options: Input<TFlags, TGlobalFlags, TArgs>Optional argv: string[]Private resultOptional options: Input<TFlags, TGlobalFlags, TArgs>Optional argv: string[]Protected showStatic analyticsStatic analyticsStatic descriptionGenerated using TypeDoc
Abstract Protected environmentsProtected exitProtected failProtected initProtected parseOptional options: Input<TFlags, TGlobalFlags, TArgs>Optional argv: string[]Private resultOptional options: Input<TFlags, TGlobalFlags, TArgs>Optional argv: string[]Protected showStatic analyticsStatic analyticsStatic descriptionGenerated using TypeDoc
An abort error is a fatal error that shouldn't be reported as a bug. +
An abort error is a fatal error that shouldn't be reported as a bug. Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer.
-Optional nextSteps: TokenItem<InlineToken>[]Optional customSections: CustomSection[]Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional nextSteps: TokenItem<InlineToken>[]Optional customSections: CustomSection[]Optional customOptional formattedOptional nextA fatal error represents an error shouldn't be rescued and that causes the execution to terminate. +
A fatal error represents an error shouldn't be rescued and that causes the execution to terminate. There shouldn't be code that catches fatal errors.
-Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional customOptional formattedOptional nextA bug error is an error that represents a bug and therefore should be reported.
-Optional customOptional formattedOptional nextGenerated using TypeDoc
A bug error is an error that represents a bug and therefore should be reported.
+Optional customOptional formattedOptional nextOptional message: stringOptional message: stringOptional options: ErrorOptionsGenerated using TypeDoc
Optional message: stringOptional message: stringOptional options: ErrorOptionsAn external error is similar to Abort but has extra command and args attributes. +
An external error is similar to Abort but has extra command and args attributes. This is useful to represent errors coming from external commands, usually executed by execa.
-Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional customOptional formattedOptional nextAbstract A fatal error represents an error shouldn't be rescued and that causes the execution to terminate. +
Abstract A fatal error represents an error shouldn't be rescued and that causes the execution to terminate. There shouldn't be code that catches fatal errors.
-Creates a new FatalError error.
-The error message.
-The type of fatal error.
-The message that recommends next steps to the user. +
Creates a new FatalError error.
+The error message.
+The type of fatal error.
+The message that recommends next steps to the user. You can pass a string a TokenizedString or a TokenItem if you need to style the message inside the error Banner component.
-Optional nextSteps: TokenItem<InlineToken>[]Message to show as "next steps" with suggestions to solve the issue.
-Optional customSections: CustomSection[]Custom sections to show in the error banner. To be used if nextSteps is not enough.
-Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional nextSteps: TokenItem<InlineToken>[]Message to show as "next steps" with suggestions to solve the issue.
+Optional customSections: CustomSection[]Custom sections to show in the error banner. To be used if nextSteps is not enough.
+Optional customOptional formattedOptional nextAn abort error is a fatal error that shouldn't be reported as a bug. +
An abort error is a fatal error that shouldn't be reported as a bug. Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer.
-Optional nextSteps: TokenItem<InlineToken>[]Optional customSections: CustomSection[]Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional nextSteps: TokenItem<InlineToken>[]Optional customSections: CustomSection[]Optional customOptional formattedOptional nextAn abort error is a fatal error that shouldn't be reported as a bug. +
An abort error is a fatal error that shouldn't be reported as a bug. Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer.
-Optional nextSteps: TokenItem<InlineToken>[]Optional customSections: CustomSection[]Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional nextSteps: TokenItem<InlineToken>[]Optional customSections: CustomSection[]Optional customOptional formattedOptional nextA wrapper around the conf package that provides a strongly-typed interface
+
A wrapper around the conf package that provides a strongly-typed interface
for accessing the local storage.
Optional cwd?: stringOptional projectPrivate Readonly configGet a value from the local storage.
-The key to get.
+Optional cwd?: stringOptional projectPrivate Readonly configSet a value in the local storage.
-Generated using TypeDoc
Set a value in the local storage.
+Returns a bug error that's thrown when the lookup of the package.json traversing the directory +
Returns a bug error that's thrown when the lookup of the package.json traversing the directory hierarchy up can't find a package.json
The directory from which the traverse has been done
An abort error.
-Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional customOptional formattedOptional nextReturns an abort error that's thrown when a directory that's expected to have +
Returns an abort error that's thrown when a directory that's expected to have a package.json doesn't have it.
The path to the directory that should contain a package.json
An abort error.
-Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional customOptional formattedOptional nextReturns an abort error that's thrown when the package manager can't be determined.
+Returns an abort error that's thrown when the package manager can't be determined.
An abort error.
-Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional customOptional formattedOptional nextGenerated using TypeDoc
Optional message: stringGenerated using TypeDoc
Optional message: stringReadonly errorCheck if a Result is an Err inferring its type. !isErr() should be used before accessing the value
Readonly errorMaps the value type to another one. It leaves the Error unaltered
This mapper method is not used for an Error value
a new result with the new value type and an unaltered error
-Maps the error to another one with a different type. It leaves the value type unaltered
-The mapper method to apply an Error value
a new result with the new mapped error
-Generated using TypeDoc
Maps the value type to another one. It leaves the Error unaltered
This mapper method is not used for an Error value
a new result with the new value type and an unaltered error
+Maps the error to another one with a different type. It leaves the value type unaltered
+The mapper method to apply an Error value
a new result with the new mapped error
+Readonly valueRuns the handler method an return the same an unaltered copy of the Result. It could be used to log an
+
Readonly valueRuns the handler method an return the same an unaltered copy of the Result. It could be used to log an
output when the result is Ok without breaking the flow
method to be run when the result is Ok
a copy of the same Result
Check if a Result is an Err inferring its type. !isErr() should be used before accessing the value
method to be run when the result is Ok
a copy of the same Result
Maps the value to another one with a different type. It leaves the Error type unaltered
The mapper method to apply an OK value
a new result with the new mapped value
-Maps the error type to another one. It leaves the Ok type and value unaltered
This mapper method is not used for an Ok value
a new result with the new mapped error type and an value
-Generated using TypeDoc
Maps the value to another one with a different type. It leaves the Error type unaltered
The mapper method to apply an OK value
a new result with the new mapped value
+Maps the error type to another one. It leaves the Ok type and value unaltered
This mapper method is not used for an Ok value
a new result with the new mapped error type and an value
+Generated using TypeDoc
Abstract Protected adminProtected Abstract contextProtected themeProtected Abstract removeProtected Abstract setGenerated using TypeDoc
Abstract Protected adminProtected Abstract contextProtected themeProtected Abstract removeProtected Abstract setPrivate Readonly _exporterProtected onProtected onGenerated using TypeDoc
Private Readonly _exporterProtected onProtected onBootstraps an Otel exporter which can send Otel metrics to a dedicated Shopify supported collector endpoint.
-Protected Readonly meterProtected Readonly metricsReadonly prefixProtected Readonly recordReadonly serviceonRecord callback is called when a metric is recorded.
+
Bootstraps an Otel exporter which can send Otel metrics to a dedicated Shopify supported collector endpoint.
+Protected Readonly meterProtected Readonly metricsReadonly prefixProtected Readonly recordReadonly serviceonRecord callback is called when a metric is recorded.
Returns a function to unsubscribe.
Protected notifyGenerated using TypeDoc
Protected notifyGenerated using TypeDoc
Bootstraps an Otel exporter which can send Otel metrics to a dedicated Shopify supported collector endpoint.
-Protected Readonly meterProtected Readonly metricsReadonly prefixProtected Readonly recordReadonly serviceonRecord callback is called when a metric is recorded.
+
Bootstraps an Otel exporter which can send Otel metrics to a dedicated Shopify supported collector endpoint.
+Protected Readonly meterProtected Readonly metricsReadonly prefixProtected Readonly recordReadonly serviceonRecord callback is called when a metric is recorded.
Returns a function to unsubscribe.
Protected notifyGenerated using TypeDoc
Protected notifyGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Creates an array of array values not included in the other provided arrays using SameValueZero for
+
Generated using TypeDoc
Returns true if an array contains duplicates.
-Returns a copy of the array deleting the elemements that are undefined.
-Takes a random value from an array.
-Removes duplicated items from an array.
-This method is like _.uniq except that it accepts iteratee which is
+
Generated using TypeDoc
Creates an object composed of keys generated from the results of running each element of collection through +
Creates an object composed of keys generated from the results of running each element of collection through iteratee. The corresponding value of each key is an array of the elements responsible for generating the key. The iteratee is invoked with one argument: (value).
-Generated using TypeDoc
Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, +
Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, while the second of which contains elements predicate returns falsey for. The predicate is invoked with three arguments: (value, index|key, collection).
-Generated using TypeDoc
Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since +
Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent @@ -6,8 +6,8 @@
Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the the debounced function is invoked more than once during the wait timeout.
See David Corbacho’s article for details over the differences between _.debounce and _.throttle.
-The function to debounce.
-Optional wait: numberThe number of milliseconds to delay.
-Optional options: DebounceSettingsThe options object.
+The function to debounce.
+Optional wait: numberThe number of milliseconds to delay.
+Optional options: DebounceSettingsThe options object.
Returns the new debounced function.
-Generated using TypeDoc
Creates a function that memoizes the result of func. If resolver is provided it determines the cache key for +
Creates a function that memoizes the result of func. If resolver is provided it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is coerced to a string and used as the cache key. The func is invoked with the this binding of the memoized function.
-Returns the new memoizing function.
-Generated using TypeDoc
Returns the new memoizing function.
+Performs a deep comparison between two values to determine if they are +
Performs a deep comparison between two values to determine if they are equivalent.
Note: This method supports comparing arrays, array buffers, booleans,
date objects, error objects, maps, numbers, Object objects, regexes,
sets, strings, symbols, and typed arrays. Object objects are compared
by their own, not inherited, enumerable properties. Functions and DOM
nodes are not supported.
The value to compare.
-The other value to compare.
+The value to compare.
+The other value to compare.
Returns true if the values are equivalent, else false.
Generated using TypeDoc
Removes the undefined elements.
-The object whose undefined will be deleted.
+Generated using TypeDoc
Deeply compares two objects and returns true if they are equal.
-The first object to be compared.
-The second object to be compared.
+Generated using TypeDoc
Return the difference between two nested objects.
-The first object to be compared.
-The second object to be compared.
+Return the difference between two nested objects.
+The first object to be compared.
+The second object to be compared.
Two objects containing the fields that are different, each one with the values of one object.
-Generated using TypeDoc
Deep merges the two objects and returns a new object with the merge result.
-One of the objects to be merged.
-Another object to be merged.
-Strategy used to merge the array typed fields. Union strategy is used by default to avoid +
Deep merges the two objects and returns a new object with the merge result.
+One of the objects to be merged.
+Another object to be merged.
+Strategy used to merge the array typed fields. Union strategy is used by default to avoid duplicated elements.
-A Javascrip tobject with th emerged objects.
-Generated using TypeDoc
A Javascrip tobject with th emerged objects.
+Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
-The object to query.
-The path of the property to get.
+Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.
+The object to query.
+The path of the property to get.
Generated using TypeDoc
Checks if value is an empty object, collection, map, or set.
-The value to check.
+Generated using TypeDoc
Creates an object with the same keys as object and values generated by running each own +
Creates an object with the same keys as object and values generated by running each own enumerable property of object through iteratee. The iteratee function is invoked with three arguments: (value, key, object).
-Generated using TypeDoc
Creates an object composed of the object properties predicate returns
+
Generated using TypeDoc
Sets the value at path of object. If a portion of path doesn't exist, it's create.
-The object to modify.
-The path of the property to set.
-Optional value: unknownThe value to set.
+Generated using TypeDoc
Perform an action optimistically. If it fails the first time, first initiate +
Perform an action optimistically. If it fails the first time, first initiate a provided recovery procedure, then retry the action. If it fails again, throw the error.
This is useful for actions that may fail due to recoverable errors, such as an expired token that can be refreshed. In this case, the recovery procedure would refresh the token.
-Generated using TypeDoc
Transform a string to camelCase.
-Given a string, it returns it with the first letter capitalized.
-String to capitalize.
+Generated using TypeDoc
Transform a string to CONSTANT_CASE.
-String to transform.
+Generated using TypeDoc
Given a string, it returns it with the special regex characters escaped. +
Given a string, it returns it with the special regex characters escaped. More info: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping.
-String to escape.
+String to escape.
The escaped string.
-Generated using TypeDoc
Given a date, return a formatted string like "2021-01-01 12:00:00".
-Generates a random name by combining an adjective and noun.
-Theme to use for the random name (business or creative).
+Generates a random name by combining an adjective and noun.
+Theme to use for the random name (business or creative).
A random name generated by combining an adjective and noun.
-Generated using TypeDoc
Transform a string to param-case.
-String to transform.
+Generated using TypeDoc
Given a list of items, it returns a string with the items joined by commas and the last item joined by "and". +
Given a list of items, it returns a string with the items joined by commas and the last item joined by "and". All items are wrapped in double quotes. For example: ["a", "b", "c"] returns "a", "b" and "c".
-List of items.
+List of items.
The joined string.
-Generated using TypeDoc
Transforms a matrix of strings into a single string with the columns aligned.
-Array of rows, where each row is an array of strings (representing columns).
+Generated using TypeDoc
Given a string that represents a list of delimited tokens, it returns the normalized string representing the same +
Given a string that represents a list of delimited tokens, it returns the normalized string representing the same list, without empty elements, sorted, and with no duplicates.
-Optional delimitedString: stringString to normalize.
-Delimiter used to split the string into tokens.
+Optional delimitedString: stringString to normalize.
+Delimiter used to split the string into tokens.
String with the normalized list of tokens.
-Generated using TypeDoc
Given a string, it returns the PascalCase form of it. +
Generated using TypeDoc
Given a list of items, it returns a pluralized string based on the amount of items.
-List of items.
-Supplier used when the list of items has more than one item.
-Supplier used when the list of items has a single item.
-Optional none: (() => TokenItem<TNoneToken>)Supplier used when the list has no items.
+Given a list of items, it returns a pluralized string based on the amount of items.
+List of items.
+Supplier used when the list of items has more than one item.
+Supplier used when the list of items has a single item.
+Optional none: (() => TokenItem<TNoneToken>)Supplier used when the list has no items.
The TokenItem supplied by the plural, singular, or none functions.
-Generated using TypeDoc
Given a string, it transforms it to a slug (lowercase, hyphenated, no special chars, trimmed...).
-Try to convert a string to an int, falling back to undefined if unable to.
-String to convert to an int.
+Generated using TypeDoc
Transform a string to snake_case.
-String to transform.
+Generated using TypeDoc
Check if the format of a URL is valid or not.
-URL to be checked.
+Generated using TypeDoc
Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.
+Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.
The payload for an event includes both generic data, and data gathered from installed plug-ins.
-Generated using TypeDoc
Executes a GraphQL query against the Admin API.
-GraphQL query to execute.
-Shopify admin session including token and Store FQDN.
-Optional variables: GraphQLVariablesGraphQL variables to pass to the query.
+Executes a GraphQL query against the Admin API.
+GraphQL query to execute.
+Shopify admin session including token and Store FQDN.
+Optional variables: GraphQLVariablesGraphQL variables to pass to the query.
The response of the query of generic type
Generated using TypeDoc
Returns the Admin API URL for the given store and version.
-Store FQDN.
-Executes a REST request against the Admin API.
-Request's HTTP method.
-Path of the REST resource.
-Shopify Admin session including token and Store FQDN.
-Optional requestBody: TRequest body of including REST resource specific parameters.
-Search params, appended to the URL.
-Admin API version.
+Executes a REST request against the Admin API.
+Request's HTTP method.
+Path of the REST resource.
+Shopify Admin session including token and Store FQDN.
+Optional requestBody: TRequest body of including REST resource specific parameters.
+Search params, appended to the URL.
+Admin API version.
Generated using TypeDoc
GraphQL query to retrieve all supported API versions.
-Shopify admin session including token and Store FQDN.
+GraphQL query to retrieve all supported API versions.
+Shopify admin session including token and Store FQDN.
Generated using TypeDoc
Executes an org-scoped GraphQL query against the App Management API.
+The organization ID.
+GraphQL query to execute.
+Partners token.
+Optional variables: GraphQLVariablesGraphQL variables to pass to the query.
+The response of the query of generic type
Sets the next deprecation date from GraphQL response extensions
+if response.extensions.deprecations objects contain a supportedUntilDate (ISO 8601-formatted string).
The response of the query.
+Executes a GraphQL query against the Business Platform Destinations API.
-GraphQL query to execute.
-Business Platform token.
-Optional variables: GraphQLVariablesGraphQL variables to pass to the query.
+Executes a GraphQL query against the Business Platform Destinations API.
+GraphQL query to execute.
+Business Platform token.
+Optional variables: GraphQLVariablesGraphQL variables to pass to the query.
The response of the query of generic type
Generated using TypeDoc
Executes a GraphQL query to an endpoint.
-GraphQL request options.
+Executes a GraphQL query to an endpoint.
+GraphQL request options.
The response of the query of generic type
Generated using TypeDoc
Request a URL from partners to which we will upload our function.
-Partners token.
+Request a URL from partners to which we will upload our function.
+Partners token.
The response of the query.
-Generated using TypeDoc
Sets the next deprecation date from GraphQL response extensions +
Sets the next deprecation date from GraphQL response extensions
if response.extensions.deprecations objects contain a supportedUntilDate (ISO 8601-formatted string).
The response of the query.
-Generated using TypeDoc
The response of the query.
+Executes a GraphQL query against the Partners API.
-GraphQL query to execute.
-Partners token.
-Optional variables: GraphQLVariablesGraphQL variables to pass to the query.
+Executes a GraphQL query against the Partners API.
+GraphQL query to execute.
+Partners token.
+Optional variables: GraphQLVariablesGraphQL variables to pass to the query.
The response of the query of generic type
Generated using TypeDoc
Sets the next deprecation date from GraphQL response extensions
-if response.extensions.deprecations objects contain a supportedUntilDate (ISO 8601-formatted string).
The response of the query.
-Generated using TypeDoc
Executes an org-scoped GraphQL query against the Developers API.
-The organization ID.
-GraphQL query to execute.
-Partners token.
-Optional variables: GraphQLVariablesGraphQL variables to pass to the query.
-The response of the query of generic type
Generated using TypeDoc
It zips a directory and by default normalizes the paths to be forward-slash. +
Generated using TypeDoc
ZipOptions.
+Generated using TypeDoc
Generated using TypeDoc
A function that abstracts away setting up the environment and running +
Generated using TypeDoc
Options.
+Generated using TypeDoc
Generated using TypeDoc
It returns the BusinessPlatform' API service we should interact with.
+Generated using TypeDoc
It returns the Identity service we should interact with.
+Generated using TypeDoc
Normalize the store name to be used in the CLI. +
Normalize the store name to be used in the CLI. It will add the .myshopify.com domain if it's not present. It will add the spin domain if it's not present and we're in a Spin environment.
-Store name.
+Store name.
Normalized store name.
-
The AbortController interface represents a controller object that allows you to abort one or more Web requests as and when desired.
+- Preparing search index...
- The search index is not available
@shopify/cli-kitClass AbortController
The AbortController interface represents a controller object that allows you to abort one or more Web requests as and when desired.
This class is necessary because AbortController support was added to Node 15 and the minimum version that we support is Node 14.
-Hierarchy
Index
Constructors
Constructors
constructor
Returns AbortController
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc