Class Client

Contains a fetch instance, provides methods to GET and POST several types

Hierarchy

Client

Index

Constructors

constructor

new Client(fetchOverride?: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)): Client
Parameters
- Optional fetchOverride: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
  - - (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
    - Parameters
      
      input: URL | RequestInfo
      
      Optional init: RequestInit
      
      Returns Promise<Response>
Returns Client
- Defined in lib/src/client.ts:59

Properties

`Private` `Optional` __fetchOverride

__fetchOverride?: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

Type declaration

- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
- Parameters
  - input: URL | RequestInfo
  - Optional init: RequestInit
  Returns Promise<Response>

Accessors

`Private` fetch

get fetch(): ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
Returns ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
- - (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
  - Parameters
    - input: URL | RequestInfo
    - Optional init: RequestInit
    Returns Promise<Response>
- Defined in lib/src/client.ts:63

Methods

fetchResourceHTTP

fetchResourceHTTP(subject: string, opts?: FetchResourceOptions): Promise<HTTPResourceResult>
Fetches and Parses a Resource. Can fetch through another atomic server if you pass the from argument, which should be the baseURL of an Atomic Server. Returns a tuple of the requested resource and a list of all resources found in the response.
Parameters
- subject: string
- opts: FetchResourceOptions = {}
Returns Promise<HTTPResourceResult>
- Defined in lib/src/client.ts:115

postCommit

postCommit(commit: Commit, endpoint: string): Promise<Commit>
Posts a Commit to some endpoint. Returns the Commit created by the server.
Parameters
- commit: Commit
- endpoint: string
  
  URL to post to, e.g. https://atomicdata.dev/commit
Returns Promise<Commit>
- Defined in lib/src/client.ts:193

setFetch

setFetch(fetchOverride: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)): void
Parameters
- fetchOverride: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
  - - (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
    - Parameters
      
      input: URL | RequestInfo
      
      Optional init: RequestInit
      
      Returns Promise<Response>
Returns void
- Defined in lib/src/client.ts:106

uploadFiles

uploadFiles(files: File[], serverUrl: string, agent: Agent, parent: string): Promise<Resource[]>
Uploads files to the /upload endpoint of the Store. Signs the Headers using the given agent. Returns the newly created resources
Parameters
- files: File[]
- serverUrl: string
- agent: Agent
- parent: string
Returns Promise<Resource[]>
- Defined in lib/src/client.ts:227

`Static` isValidSubject

isValidSubject(subject: undefined | string): boolean
Returns true if the given subject is valid
Parameters
- subject: undefined | string
Returns boolean
- Defined in lib/src/client.ts:85

`Static` removeQueryParamsFromURL

removeQueryParamsFromURL(subject: string): string
Removes query params from the URL if it can build a URL. Will return the normal URL if things go wrong.
Parameters
- subject: string
Returns string
- Defined in lib/src/client.ts:102

`Static` tryValidSubject

tryValidSubject(subject: undefined | string): void
Throws an error if the subject is not valid
Parameters
- subject: undefined | string
Returns void
- Defined in lib/src/client.ts:76

Class Client

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional fetchOverride: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

Parameters

input: URL | RequestInfo

Optional init: RequestInit

Returns Promise<Response>

Returns Client

Properties

Private Optional __fetchOverride

Type declaration

Parameters

input: URL | RequestInfo

Optional init: RequestInit

Returns Promise<Response>

Accessors

Private fetch

Returns ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

Parameters

input: URL | RequestInfo

Optional init: RequestInit

Returns Promise<Response>

Methods

fetchResourceHTTP

Parameters

subject: string

opts: FetchResourceOptions = {}

Returns Promise<HTTPResourceResult>

postCommit

Parameters

commit: Commit

endpoint: string

Returns Promise<Commit>

setFetch

Parameters

fetchOverride: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

Parameters

input: URL | RequestInfo

Optional init: RequestInit

Returns Promise<Response>

Returns void

uploadFiles

Parameters

files: File[]

serverUrl: string

agent: Agent

parent: string

Returns Promise<Resource[]>

Static isValidSubject

Parameters

subject: undefined | string

Returns boolean

Static removeQueryParamsFromURL

Parameters

subject: string

Returns string

Static tryValidSubject

Parameters

subject: undefined | string

Returns void

Settings

Member Visibility

Theme

`Optional` fetchOverride: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

`Optional` init: RequestInit

`Private` `Optional` __fetchOverride

`Optional` init: RequestInit

`Private` fetch

`Optional` init: RequestInit

`Optional` init: RequestInit

`Static` isValidSubject

`Static` removeQueryParamsFromURL

`Static` tryValidSubject