Skip to content

Expand HTTP driver docs#1016

Open
cerredz wants to merge 1 commit into
cyclejs:masterfrom
cerredz:issuehunt-851-http-api-docs
Open

Expand HTTP driver docs#1016
cerredz wants to merge 1 commit into
cyclejs:masterfrom
cerredz:issuehunt-851-http-api-docs

Conversation

@cerredz
Copy link
Copy Markdown

@cerredz cerredz commented May 16, 2026

/claim #851

Contributes to #851.

This adds another focused docs-revamp slice for @cycle/http. It expands the HTTP API page with:

  • driver setup with the DOM driver included in the example
  • basic request/response flow using categories
  • common request object shapes for GET, POST, headers, query, upload, and progress
  • guidance on select(), response metastreams, the response$.request field, flatten(), and flattenConcurrently()
  • examples for custom HTTPSource.filter() usage
  • xstream and RxJS error-handling examples on inner response streams
  • HTTP isolation semantics with a component example

I also mirrored the Markdown content into the checked-in docs/api/http.html wrapper because the docs generator is currently blocked in this checkout.

Verification run locally:

  • node --check .scripts/make-api-docs.js
  • git diff --check
  • embedded-markdown consistency check between docs/content/api/http.md and docs/api/http.html

I also tried regenerating the rendered API HTML with:

  • node .scripts/make-api-docs.js http

That fails in the existing docs toolchain because the installed GitHub tarball for dox throws TypeError: parse is not a function, matching the same pre-existing generator failure seen on the other docs-revamp branches.

@cerredz cerredz force-pushed the issuehunt-851-http-api-docs branch from ad54f08 to 9fbe7ac Compare May 16, 2026 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant