Skip to content

Commit

Permalink
docs: attempt documenting exported modules
Browse files Browse the repository at this point in the history
this doesn't actually show up when you import these things. looking into
it. in the meantime, it's useful to have the notes I wrote, so we can
actually export them in the future.
  • Loading branch information
chadoh committed May 15, 2024
1 parent c1e44ec commit 8bf93ea
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,33 @@ export * as Friendbot from './friendbot';
// Horizon-related classes to expose
export * as Horizon from './horizon';

// Soroban RPC-related classes to expose
/**
* Tools for interacting with the Soroban RPC server, such as `Server`,
* `assembleTransaction`, and the `Api` types. You can import these from the
* `/rpc` entrypoint, if your version of Node and your TypeScript configuration
* allow it:
*
* ```ts
* import { Server } from '@stellar/stellar-sdk/rpc';
* ```
*/
export * as rpc from './rpc';

/**
* @deprecated Use `rpc` instead
*/
export * as SorobanRpc from './rpc';

// Soroban Contract-related classes to expose
/**
* Tools for interacting with smart contracts, such as `Client`, `Spec`, and
* `AssembledTransaction`. You can import these from the `/contract`
* entrypoint, if your version of Node and your TypeScript configuration allow
* it:
*
* ```ts
* import { Client } from '@stellar/stellar-sdk/contract';
* ```
*/
export * as contract from './contract'

// expose classes and functions from stellar-base
Expand Down

0 comments on commit 8bf93ea

Please sign in to comment.