Skip to content
Alchemy Logo

validateAlchemyConnectionConfig

function validateAlchemyConnectionConfig(config): Object;

Defined in: packages/common/src/transport/connectionSchema.ts:107

Validates an Alchemy connection configuration object.

try {
  const config = validateAlchemyConnectionConfig({
    apiKey: "your-api-key",
  });
  // config is now typed as AlchemyConnectionConfig
} catch (error) {
  if (error instanceof ConnectionConfigError) {
    console.error("Invalid config:", error.message);
  }
}

ParameterTypeDescription

config

unknown

The configuration object to validate

Object

The validated configuration object

If the configuration is invalid

Was this page helpful?