Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve function documentation #1916

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: improve function documentation #1916

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b85bc38
Update OnchainKitConfig.ts
DeVikingMark Feb 2, 2025
8896e6e
Update createWagmiConfig.ts
DeVikingMark Feb 2, 2025
47e9780
Update createWagmiConfig.ts
DeVikingMark Feb 20, 2025
45d0c44
Update types.ts
DeVikingMark Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/core/OnchainKitConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ export const getOnchainKitConfig = <K extends keyof typeof ONCHAIN_KIT_CONFIG>(
/**
* Update the ONCHAIN_KIT_CONFIG object directly by providing the properties to update.
* This is powerful when you use OnchainKit utilities outside of the React context.
*
* @param {SetOnchainKitConfig} properties - Properties to update in the configuration
* @returns {Function} Returns the getOnchainKitConfig function for chaining
*/
export const setOnchainKitConfig = (properties: SetOnchainKitConfig) => {
Object.assign(ONCHAIN_KIT_CONFIG, properties);
Expand Down
6 changes: 6 additions & 0 deletions src/core/createWagmiConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ import type { CreateWagmiConfigParams } from './types';
/**
* createWagmiConfig returns a WagmiConfig (https://wagmi.sh/react/api/createConfig) using OnchainKit provided settings.
* This function should only be used if the user does not provide WagmiProvider as a parent in the React context.
*
* @param {Object} params - Configuration parameters
* @param {string} [params.apiKey] - Optional API key for Coinbase Developer Platform
* @param {string} [params.appName] - Optional application name for Coinbase Wallet
* @param {string} [params.appLogoUrl] - Optional application logo URL for Coinbase Wallet
* @returns {Config} Wagmi configuration object
*/
export const createWagmiConfig = ({
apiKey,
Expand Down
Loading