Skip to content
v2.273.0

ISchema Interface ​

Interface for implementing your own schema.

Useful for providing schema's from sources other than assets

Methods ​

bind(api: IGraphQLApiRef, options?: SchemaBindOptions): ISchemaConfigdef bind(self, api: IGraphQLApiRef, options: typing.Optional[SchemaBindOptions] = None) -> ISchemaConfigpublic ISchemaConfig bind(IGraphQLApiRef api, SchemaBindOptions options)public ISchemaConfig Bind(IGraphQLApiRef api, SchemaBindOptions? options = null)func Bind(Api IGraphQLApiRef, Options SchemaBindOptions) ISchemaConfig#
Binds a schema string to a GraphQlApi.
2 parameters · returns

Parameters

  • apiapiapiapiApi — the api to bind the schema to.
  • optionsoptionsoptionsoptionsOptions — configuration for bind behavior.

Returns: ISchemaConfig with apiId and schema definition string