mirror of
https://github.com/ilyakooo0/urbit.git
synced 2024-11-29 12:15:43 +03:00
http-api: fixing Thread type
This commit is contained in:
parent
326a14f237
commit
2db9461e48
@ -1,7 +1,6 @@
|
||||
|
||||
/**
|
||||
* An urbit style path, rendered as a Javascript string
|
||||
* @example
|
||||
* @example
|
||||
* `"/updates"`
|
||||
*/
|
||||
export type Path = string;
|
||||
@ -28,7 +27,6 @@ export type Patp = string;
|
||||
*/
|
||||
export type PatpNoSig = string;
|
||||
|
||||
|
||||
/**
|
||||
* The name of a clay mark, as a string
|
||||
*
|
||||
@ -43,43 +41,43 @@ export type Mark = string;
|
||||
* The name of a gall agent, as a string
|
||||
*
|
||||
* @example
|
||||
*
|
||||
*
|
||||
* ```typescript
|
||||
* "graph-store"
|
||||
* ```
|
||||
*/
|
||||
export type GallAgent = string;
|
||||
|
||||
/**
|
||||
/**
|
||||
* Description of an outgoing poke
|
||||
*
|
||||
*
|
||||
* @typeParam Action - Typescript type of the data being poked
|
||||
*/
|
||||
export interface Poke<Action> {
|
||||
/**
|
||||
* Ship to poke. If left empty, the api lib will populate it with the ship that it is connected to.
|
||||
*
|
||||
* Ship to poke. If left empty, the api lib will populate it with the ship that it is connected to.
|
||||
*
|
||||
* @remarks
|
||||
*
|
||||
* This should always be the ship that you are connected to
|
||||
*
|
||||
*
|
||||
*/
|
||||
ship?: PatpNoSig;
|
||||
/**
|
||||
ship?: PatpNoSig;
|
||||
/**
|
||||
*/
|
||||
app: GallAgent;
|
||||
/**
|
||||
* Mark of the cage to be poked
|
||||
*
|
||||
* Mark of the cage to be poked
|
||||
*
|
||||
*/
|
||||
mark: Mark;
|
||||
/**
|
||||
/**
|
||||
* Vase of the cage of to be poked, as JSON
|
||||
*/
|
||||
json: Action;
|
||||
}
|
||||
|
||||
/**
|
||||
/**
|
||||
* Description of a scry request
|
||||
*/
|
||||
export interface Scry {
|
||||
@ -91,11 +89,11 @@ export interface Scry {
|
||||
|
||||
/**
|
||||
* Description of a thread request
|
||||
*
|
||||
*
|
||||
* @typeParam Action - Typescript type of the data being poked
|
||||
*/
|
||||
export interface Thread<Action> {
|
||||
/**
|
||||
/**
|
||||
* The mark of the input vase
|
||||
*/
|
||||
inputMark: Mark;
|
||||
@ -103,7 +101,7 @@ export interface Thread<Action> {
|
||||
* The mark of the output vase
|
||||
*/
|
||||
outputMark: Mark;
|
||||
/**
|
||||
/**
|
||||
* Name of the thread
|
||||
*
|
||||
* @example
|
||||
@ -115,7 +113,7 @@ export interface Thread<Action> {
|
||||
/**
|
||||
* Desk of thread
|
||||
*/
|
||||
desk: string;
|
||||
desk?: string;
|
||||
/**
|
||||
* Data of the input vase
|
||||
*/
|
||||
@ -124,9 +122,6 @@ export interface Thread<Action> {
|
||||
|
||||
export type Action = 'poke' | 'subscribe' | 'ack' | 'unsubscribe' | 'delete';
|
||||
|
||||
|
||||
|
||||
|
||||
export interface PokeHandlers {
|
||||
onSuccess?: () => void;
|
||||
onError?: (e: any) => void;
|
||||
@ -143,7 +138,7 @@ export interface AuthenticationInterface {
|
||||
|
||||
/**
|
||||
* Subscription event handlers
|
||||
*
|
||||
*
|
||||
*/
|
||||
export interface SubscriptionInterface {
|
||||
/**
|
||||
@ -154,7 +149,7 @@ export interface SubscriptionInterface {
|
||||
* Handle %fact
|
||||
*/
|
||||
event?(data: any): void;
|
||||
/**
|
||||
/**
|
||||
* Handle %kick
|
||||
*/
|
||||
quit?(data: any): void;
|
||||
@ -182,14 +177,13 @@ export interface headers {
|
||||
Cookie?: string;
|
||||
}
|
||||
|
||||
|
||||
export interface CustomEventHandler {
|
||||
(data: any, response: string): void;
|
||||
}
|
||||
|
||||
export interface SSEOptions {
|
||||
headers?: {
|
||||
Cookie?: string
|
||||
Cookie?: string;
|
||||
};
|
||||
withCredentials?: boolean;
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user