crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
protocol/packages/connect/docs/reference.mdx
xianny f65d8cc325 Updated CHANGELOGS & MD docs
2019-11-05 16:58:00 -08:00

533 lines
8.3 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Type aliases
### AssetPairsResponse
Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›*
*Defined in [types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L416)*
___
### FeeRecipientsResponse
Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›*
*Defined in [types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L484)*
___
### OrdersResponse
Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›*
*Defined in [types/src/index.ts:404](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L404)*
___
# Interface: APIOrder
## Properties
### metaData
• **metaData**: *object*
*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L408)*
___
### order
• **order**: *[SignedOrder](#class-signedorder)*
*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L407)*
<hr />
# Interface: PagedRequestOpts
## Properties
### `Optional` page
• **page**? : *undefined | number*
*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L491)*
___
### `Optional` perPage
• **perPage**? : *undefined | number*
*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L492)*
<hr />
# Interface: PaginatedCollection <**T**>
## Type parameters
▪ **T**
## Properties
### page
• **page**: *number*
*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L459)*
___
### perPage
• **perPage**: *number*
*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L460)*
___
### records
• **records**: *`T`[]*
*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L461)*
___
### total
• **total**: *number*
*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L458)*
<hr />
# Interface: RequestOpts
## Properties
### `Optional` networkId
• **networkId**? : *undefined | number*
*Defined in [types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L487)*
<hr />
# Interface: SignedOrder
## Properties
### chainId
• **chainId**: *number*
*Inherited from [Order](#interface-order).[chainId](#chainid)*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)*
___
### exchangeAddress
• **exchangeAddress**: *string*
*Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)*
___
### expirationTimeSeconds
• **expirationTimeSeconds**: *`BigNumber`*
*Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)*
*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)*
___
### feeRecipientAddress
• **feeRecipientAddress**: *string*
*Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)*
___
### makerAddress
• **makerAddress**: *string*
*Inherited from [Order](#interface-order).[makerAddress](#makeraddress)*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)*
___
### makerAssetAmount
• **makerAssetAmount**: *`BigNumber`*
*Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)*
___
### makerAssetData
• **makerAssetData**: *string*
*Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)*
*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)*
___
### makerFee
• **makerFee**: *`BigNumber`*
*Inherited from [Order](#interface-order).[makerFee](#makerfee)*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)*
___
### makerFeeAssetData
• **makerFeeAssetData**: *string*
*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)*
*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)*
___
### salt
• **salt**: *`BigNumber`*
*Inherited from [Order](#interface-order).[salt](#salt)*
*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)*
___
### senderAddress
• **senderAddress**: *string*
*Inherited from [Order](#interface-order).[senderAddress](#senderaddress)*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)*
___
### signature
• **signature**: *string*
*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L33)*
___
### takerAddress
• **takerAddress**: *string*
*Inherited from [Order](#interface-order).[takerAddress](#takeraddress)*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)*
___
### takerAssetAmount
• **takerAssetAmount**: *`BigNumber`*
*Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)*
___
### takerAssetData
• **takerAssetData**: *string*
*Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)*
*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)*
___
### takerFee
• **takerFee**: *`BigNumber`*
*Inherited from [Order](#interface-order).[takerFee](#takerfee)*
*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)*
___
### takerFeeAssetData
• **takerFeeAssetData**: *string*
*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)*
*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)*
<hr />
<hr />
<hr />
## Object literals
### `Const` ordersChannelFactory
#### ▪ **ordersChannelFactory**: *object*
*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/connect/src/orders_channel_factory.ts#L7)*
#### createWebSocketOrdersChannelAsync
▸ **createWebSocketOrdersChannelAsync**(`url`: string, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *`Promise<OrdersChannel>`*
*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/connect/src/orders_channel_factory.ts#L15)*
Instantiates a new WebSocketOrdersChannel instance
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`url` | string | The relayer API base WS url you would like to interact with |
`handler` | [OrdersChannelHandler](#interface-orderschannelhandler) | An OrdersChannelHandler instance that responds to various channel updates |
**Returns:** *`Promise<OrdersChannel>`*
An OrdersChannel Promise
<hr />
Reference in New Issue View Git Blame Copy Permalink