Skip to content

Commit

Permalink
fix(client): Export relevant elements from the browser bundle
Browse files Browse the repository at this point in the history
Closes: enisdenjo#97
  • Loading branch information
enisdenjo committed Jan 19, 2021
1 parent 792b473 commit b106dbe
Show file tree
Hide file tree
Showing 10 changed files with 375 additions and 0 deletions.
54 changes: 54 additions & 0 deletions docs/enums/client.messagetype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
[graphql-ws](../README.md) / [client](../modules/client.md) / MessageType

# Enumeration: MessageType

[client](../modules/client.md).MessageType

Types of messages allowed to be sent by the client/server over the WS protocol.

## Table of contents

### Enumeration members

- [Complete](client.messagetype.md#complete)
- [ConnectionAck](client.messagetype.md#connectionack)
- [ConnectionInit](client.messagetype.md#connectioninit)
- [Error](client.messagetype.md#error)
- [Next](client.messagetype.md#next)
- [Subscribe](client.messagetype.md#subscribe)

## Enumeration members

### Complete

**Complete**: = "complete"

___

### ConnectionAck

**ConnectionAck**: = "connection\_ack"

___

### ConnectionInit

**ConnectionInit**: = "connection\_init"

___

### Error

**Error**: = "error"

___

### Next

**Next**: = "next"

___

### Subscribe

**Subscribe**: = "subscribe"
28 changes: 28 additions & 0 deletions docs/interfaces/client.completemessage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[graphql-ws](../README.md) / [client](../modules/client.md) / CompleteMessage

# Interface: CompleteMessage

[client](../modules/client.md).CompleteMessage

## Hierarchy

* **CompleteMessage**

## Table of contents

### Properties

- [id](client.completemessage.md#id)
- [type](client.completemessage.md#type)

## Properties

### id

`Readonly` **id**: *string*

___

### type

`Readonly` **type**: [*Complete*](../enums/message.messagetype.md#complete)
28 changes: 28 additions & 0 deletions docs/interfaces/client.connectionackmessage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[graphql-ws](../README.md) / [client](../modules/client.md) / ConnectionAckMessage

# Interface: ConnectionAckMessage

[client](../modules/client.md).ConnectionAckMessage

## Hierarchy

* **ConnectionAckMessage**

## Table of contents

### Properties

- [payload](client.connectionackmessage.md#payload)
- [type](client.connectionackmessage.md#type)

## Properties

### payload

`Optional` `Readonly` **payload**: *undefined* \| *Record*<*string*, *unknown*\>

___

### type

`Readonly` **type**: [*ConnectionAck*](../enums/message.messagetype.md#connectionack)
28 changes: 28 additions & 0 deletions docs/interfaces/client.connectioninitmessage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[graphql-ws](../README.md) / [client](../modules/client.md) / ConnectionInitMessage

# Interface: ConnectionInitMessage

[client](../modules/client.md).ConnectionInitMessage

## Hierarchy

* **ConnectionInitMessage**

## Table of contents

### Properties

- [payload](client.connectioninitmessage.md#payload)
- [type](client.connectioninitmessage.md#type)

## Properties

### payload

`Optional` `Readonly` **payload**: *undefined* \| *Record*<*string*, *unknown*\>

___

### type

`Readonly` **type**: [*ConnectionInit*](../enums/message.messagetype.md#connectioninit)
35 changes: 35 additions & 0 deletions docs/interfaces/client.errormessage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[graphql-ws](../README.md) / [client](../modules/client.md) / ErrorMessage

# Interface: ErrorMessage

[client](../modules/client.md).ErrorMessage

## Hierarchy

* **ErrorMessage**

## Table of contents

### Properties

- [id](client.errormessage.md#id)
- [payload](client.errormessage.md#payload)
- [type](client.errormessage.md#type)

## Properties

### id

`Readonly` **id**: *string*

___

### payload

`Readonly` **payload**: readonly *GraphQLError*[]

___

### type

`Readonly` **type**: [*Error*](../enums/message.messagetype.md#error)
35 changes: 35 additions & 0 deletions docs/interfaces/client.nextmessage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[graphql-ws](../README.md) / [client](../modules/client.md) / NextMessage

# Interface: NextMessage

[client](../modules/client.md).NextMessage

## Hierarchy

* **NextMessage**

## Table of contents

### Properties

- [id](client.nextmessage.md#id)
- [payload](client.nextmessage.md#payload)
- [type](client.nextmessage.md#type)

## Properties

### id

`Readonly` **id**: *string*

___

### payload

`Readonly` **payload**: *ExecutionResult*<{ [key: string]: *any*; }, { [key: string]: *any*; }\>

___

### type

`Readonly` **type**: [*Next*](../enums/message.messagetype.md#next)
35 changes: 35 additions & 0 deletions docs/interfaces/client.subscribemessage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[graphql-ws](../README.md) / [client](../modules/client.md) / SubscribeMessage

# Interface: SubscribeMessage

[client](../modules/client.md).SubscribeMessage

## Hierarchy

* **SubscribeMessage**

## Table of contents

### Properties

- [id](client.subscribemessage.md#id)
- [payload](client.subscribemessage.md#payload)
- [type](client.subscribemessage.md#type)

## Properties

### id

`Readonly` **id**: *string*

___

### payload

`Readonly` **payload**: [*SubscribePayload*](message.subscribepayload.md)

___

### type

`Readonly` **type**: [*Subscribe*](../enums/message.messagetype.md#subscribe)
35 changes: 35 additions & 0 deletions docs/interfaces/client.subscribepayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[graphql-ws](../README.md) / [client](../modules/client.md) / SubscribePayload

# Interface: SubscribePayload

[client](../modules/client.md).SubscribePayload

## Hierarchy

* **SubscribePayload**

## Table of contents

### Properties

- [operationName](client.subscribepayload.md#operationname)
- [query](client.subscribepayload.md#query)
- [variables](client.subscribepayload.md#variables)

## Properties

### operationName

`Optional` `Readonly` **operationName**: *undefined* \| *null* \| *string*

___

### query

`Readonly` **query**: *string*

___

### variables

`Optional` `Readonly` **variables**: *undefined* \| *null* \| *Record*<*string*, *unknown*\>
Loading

0 comments on commit b106dbe

Please sign in to comment.