Skip to content
This repository has been archived by the owner on Oct 25, 2021. It is now read-only.

Commit

Permalink
lint
Browse files Browse the repository at this point in the history
  • Loading branch information
wheresrhys committed Mar 2, 2020
1 parent d57fa9d commit b9f8d69
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions packages/tc-schema-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ In many ways, this is the beating heart of Treecreeper. It consumes the schema f
The package exports a singleton instance, and once initialised, `@financial-times/biz-ops-schema` can be required multiple times in the application. It should be initialised _once and once only per application_. It also exports a reference to the underlying `SDK` class, but this is only exposed for use by other packages' integration tests.

### Initialisation

This is a little odd (and should be improved in future)
- When using local, static data (`schemaDirectory` or `schemaData` options below), the `init()` method populates the sdk with data immediately and its methods can be used to access the data immediately
- When using remote data (`schemaBaseUrl`), no data is populated, and `schema.ready()` must be awaited before using the sdk's synchronous methods.

- When using local, static data (`schemaDirectory` or `schemaData` options below), the `init()` method populates the sdk with data immediately and its methods can be used to access the data immediately
- When using remote data (`schemaBaseUrl`), no data is populated, and `schema.ready()` must be awaited before using the sdk's synchronous methods.

Be aware of the idiosyncrasy above if oyu ever come across errors complaining that no data is available.

Expand Down

0 comments on commit b9f8d69

Please sign in to comment.