From 5a09ca8d1e3c827af09cff3a60e0ad005ddfe793 Mon Sep 17 00:00:00 2001 From: "trop[bot]" <37223003+trop[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 10:39:58 -0600 Subject: [PATCH] docs: clarify that sessions use cache by default (#44576) Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: Niklas Wenzel --- docs/api/session.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/api/session.md b/docs/api/session.md index 8b56af1897fd..0221cc264f49 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -27,7 +27,8 @@ The `session` module has the following methods: * `partition` string * `options` Object (optional) - * `cache` boolean - Whether to enable cache. + * `cache` boolean - Whether to enable cache. Default is `true` unless the + [`--disable-http-cache` switch](command-line-switches.md#--disable-http-cache) is used. Returns `Session` - A session instance from `partition` string. When there is an existing `Session` with the same `partition`, it will be returned; otherwise a new @@ -46,7 +47,8 @@ of an existing `Session` object. * `path` string * `options` Object (optional) - * `cache` boolean - Whether to enable cache. + * `cache` boolean - Whether to enable cache. Default is `true` unless the + [`--disable-http-cache` switch](command-line-switches.md#--disable-http-cache) is used. Returns `Session` - A session instance from the absolute path as specified by the `path` string. When there is an existing `Session` with the same absolute path, it