Basics
API Reference
Preferences
Use the Preferences API to make your extension configurable.
Required preferences need to be set by the user before a command opens. They are a great way to make sure that the user of your extension has everything set up properly.
API Reference
getPreferenceValues
A function to access the preference values that have been passed to the command.
Each preference name is mapped to its value, and the defined default values are used as fallback values.
Signature
1
function getPreferenceValues(): { [preferenceName: string]: any };
Copied!
Example
1
import { getPreferenceValues } from "@raycast/api";
2
​
3
interface Preferences {
4
name: string;
5
bodyWeight?: string;
6
bodyHeight?: string;
7
}
8
​
9
export default async () => {
10
const preferences = getPreferenceValues<Preferences>();
11
console.log(preferences);
12
};
Copied!
Return
An object with the preference names as property key and the typed value as property value.
Depending on the type of the preference, the type of its value will be different.
Preference type
Value type
textfieldstringpasswordstringcheckboxbooleandropdownstringappPickerLast modified 3d ago
Copy link
Edit on GitHub