Getting Started
In addition to the Raycast API which is bundled as part of the app, we also provide a sibling package that contains a set of utilities to streamline common patterns and operations used in extensions.
Installation
This package can be installed independently using npm
.
@raycast/utils
has a peer dependency on @raycast/api
. This means that a certain version of utils
will require a version above a certain version of api
. npm
will warn you if that is not the case.
Changelog
v1.17.0
Add a new
createDeeplink
function.
v1.16.5
Fixed the bug where
failureToastOptions
did not apply foruseExec
anduseStreamJSON
hooks.
v1.16.4
Avoid throwing an error when
useFetch
can't parse theContent-Type
header of the response.
v1.16.3
Fix an issue where
URLSearchParams
couldn't be passed as an option touseFetch
oruseCachedPromise
, causing extensions to crash.
v1.16.2
Fixed the refresh token flow to log out the user instead of throwing an error.
v1.16.1
Fixed an issue where
bodyEncoding
wasn't properly used in OAuthService.
v1.16.0
Add a
failureToastOptions
prop touseFetch
,useCachedPromise
, andusePromise
to make it possible to customize the error displayed instead of a generic "Failed to fetch latest data".
v1.15.0
Add
useLocalStorage
hook.
v1.14.0
Add
useStreamJSON
hook.
v1.13.6
Updated
useFetch
'smapResult
type to allow returningcursor
in addition todata
andhasMore
.
v1.13.5
Extended
PaginationOptions
withcursor
.
v1.13.4
Fixed non-paginated version of
useFetch
not being re-run whenurl
changes.
v1.13.3
Fixed
optimisticUpdate
not working when paginating beyond the first page when usinguseCachedPromise
or other hooks that build on top of it..Fixed
useFetch
type requiringmapResult
for non-paginated overload.
v1.13.2
Added default OAuth URLs for Google, Jira, and Zoom
v1.13.1
Fixed
useFetch
type for non-paginated overload.
v1.13.0
Added pagination support to
usePromise
,useCachedPromise
anduseFetch
.
v1.12.5
Add string array support for OAuth scope (Thanks @tonka3000!).
v1.12.4
Add
tokenResponseParser
andtokenRefreshResponseParser
in the options ofOAuthService
.Fix built-in Slack OAuthServices.
v1.12.3
Fixed bodyEncoding for some built-in OAuthServices.
v1.12.2
Fixed types for
OAuthService.slack
.
v1.12.1
Fixed the refresh flow of
OAuthService
that would return outdated tokens.
v1.12.0
Removed some default OAuth clientIDs that could not work with generic scopes.
Fixed
withAccessToken
when used in no-view commands.
v1.11.1
Fixed Google OAuth configuration.
v1.11.0
Added the OAuth utils.
v1.10.1
Fix an issue where the values passed to the
reset
function of theuseForm
hook wouldn't be respected.
v1.10.0
Add a new
showFailureToast
function.
v1.9.1
Fix an issue where
useForm
'sreset
function would not reset the value of some fields (which defeats its purpose...)
v1.9.0
Add a new
useFrecencySorting
hook.Change the default
options.timeout
ofuseExec
to 10s.
v1.8.0
Add a new
runAppleScript
function.Change the default
options.timeout
ofuseExec
to 10s.
v1.7.1
Change the signature of getProgressIcon
to accept a Color
in addition to a string for the options.background
.
v1.7.0
Change the signature of getProgressIcon
to accept a Color
in addition to a string for the color
.
v1.6.0
Added the useAI
hook.
v1.4.0
Added the useSQL
hook.
v1.3.1
Added the
reset
method touseForm
.
v1.3.0
Added the
focus
method touseForm
.Added the
input
option touseExec
.
v1.2.0
Added useExec
and useForm
hooks.
v1.1.0
Added getFavicon
method.
v1.0.0
First release of the utilities.
Last updated