From 0d481aaeb8a4f77b1aebf205657132d79d64aa15 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Fri, 17 Jun 2016 12:16:15 -0700 Subject: [PATCH 01/13] :memo: use h3 headings for events and methods, per the styleguide --- docs-translations/jp/api/session.md | 44 ++++++++-------- docs-translations/ko-KR/api/menu.md | 2 +- docs-translations/ko-KR/api/session.md | 54 +++++++++---------- docs-translations/ko-KR/api/web-contents.md | 4 +- docs-translations/zh-CN/api/session.md | 50 +++++++++--------- docs-translations/zh-CN/api/web-contents.md | 4 +- docs/api/session.md | 58 ++++++++++----------- docs/api/web-contents.md | 4 +- 8 files changed, 110 insertions(+), 110 deletions(-) diff --git a/docs-translations/jp/api/session.md b/docs-translations/jp/api/session.md index a5d47d404a..84e0d08deb 100644 --- a/docs-translations/jp/api/session.md +++ b/docs-translations/jp/api/session.md @@ -70,7 +70,7 @@ session.defaultSession.on('will-download', function(event, item, webContents) { `Session`のインスタンス上で次のメソッドが提供されています: -#### `ses.cookies` +### `ses.cookies` `cookies`は、cookiesに問い合わせしたり、修正をできるようにします。例: @@ -94,7 +94,7 @@ session.defaultSession.cookies.set(cookie, function(error) { }); ``` -#### `ses.cookies.get(filter, callback)` +### `ses.cookies.get(filter, callback)` * `filter` Object * `url` String (オプション) - `url`に関連付けられているcookiesを取得します。空の場合すべてのurlのcookiesを取得します @@ -122,7 +122,7 @@ session.defaultSession.cookies.set(cookie, function(error) { cookieの有効期限をUNIX時間で何秒かを示します。セッションcookiesは提供されません。 -#### `ses.cookies.set(details, callback)` +### `ses.cookies.set(details, callback)` * `details` Object * `url` String - `url`に関連付けられているcookiesを取得します。 @@ -137,7 +137,7 @@ cookieの有効期限をUNIX時間で何秒かを示します。セッションc `details`でcookieを設定し、完了すると`callback(error)`で`callback`がコールされます。 -#### `ses.cookies.remove(url, name, callback)` +### `ses.cookies.remove(url, name, callback)` * `url` String - cookieに関連付けられているURL * `name` String - 削除するcookieの名前 @@ -145,20 +145,20 @@ cookieの有効期限をUNIX時間で何秒かを示します。セッションc `url` と `name`と一致するcookiesを削除し、完了すると`callback`が、`callback()`でコールされます。 -#### `ses.getCacheSize(callback)` +### `ses.getCacheSize(callback)` * `callback` Function * `size` Integer - 使用しているキャッシュサイズバイト数 現在のセッションのキャッシュサイズを返します。 -#### `ses.clearCache(callback)` +### `ses.clearCache(callback)` * `callback` Function - 操作が完了したら、コールされます。 セッションのHTTPキャッシュをクリアします。 -#### `ses.clearStorageData([options, ]callback)` +### `ses.clearStorageData([options, ]callback)` * `options` Object (オプション) * `origin` String - `window.location.origin`の説明で、`scheme://host:port`に従う @@ -171,11 +171,11 @@ cookieの有効期限をUNIX時間で何秒かを示します。セッションc ウェブストレージのデータをクリアします。 -#### `ses.flushStorageData()` +### `ses.flushStorageData()` 書き込まれていないDOMStorageデータをディスクに書き込みます。 -#### `ses.setProxy(config, callback)` +### `ses.setProxy(config, callback)` * `config` Object * `pacScript` String - PACファイルに関連付けらえたURL @@ -213,13 +213,13 @@ proxyURL = ["://"][":"] `url`をプロキシ情報で解決します。リクエストが実行された時、`callback(proxy)`で `callback`がコールされます。 -#### `ses.setDownloadPath(path)` +### `ses.setDownloadPath(path)` * `path` String - ダウンロード場所 ダウンロードの保存ディレクトリを設定します。既定では、ダウンロードディレクトリは、個別のアプリフォルダー下の`Downloads`です。 -#### `ses.enableNetworkEmulation(options)` +### `ses.enableNetworkEmulation(options)` * `options` Object * `offline` Boolean - ネットワーク停止を再現するかどうか @@ -241,11 +241,11 @@ window.webContents.session.enableNetworkEmulation({ window.webContents.session.enableNetworkEmulation({offline: true}); ``` -#### `ses.disableNetworkEmulation()` +### `ses.disableNetworkEmulation()` `session`ですでに有効になっているネットワークエミュレーションを無効化します。オリジナルのネットワーク設定にリセットします。 -#### `ses.setCertificateVerifyProc(proc)` +### `ses.setCertificateVerifyProc(proc)` * `proc` Function @@ -262,7 +262,7 @@ myWindow.webContents.session.setCertificateVerifyProc(function(hostname, cert, c }); ``` -#### `ses.webRequest` +### `ses.webRequest` `webRequest`APIセットをインターセプトし、そのライフタイムの様々な段階でリクエストの内容を変更できます。 @@ -284,7 +284,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, }); ``` -#### `ses.webRequest.onBeforeRequest([filter, ]listener)` +### `ses.webRequest.onBeforeRequest([filter, ]listener)` * `filter` Object * `listener` Function @@ -312,7 +312,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `cancel` Boolean (オプション) * `redirectURL` String (オプション) - オリジナルリクエストが送信もしくは完了するのを中断し、代わりに付与したURLにリダイレクトします。 -#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` +### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -334,7 +334,7 @@ The `callback` has to be called with an `response` object: * `cancel` Boolean (オプション) * `requestHeaders` Object (オプション) - 付与されると、リクエストはそれらのヘッダーで作成されます。 -#### `ses.webRequest.onSendHeaders([filter, ]listener)` +### `ses.webRequest.onSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -349,7 +349,7 @@ The `callback` has to be called with an `response` object: * `timestamp` Double * `requestHeaders` Object -#### `ses.webRequest.onHeadersReceived([filter,] listener)` +### `ses.webRequest.onHeadersReceived([filter,] listener)` * `filter` Object * `listener` Function @@ -373,7 +373,7 @@ The `callback` has to be called with an `response` object: * `cancel` Boolean * `responseHeaders` Object (オプション) - 付与されていると、これらのヘッダーでサーバーはレスポンスしたと仮定します。 -#### `ses.webRequest.onResponseStarted([filter, ]listener)` +### `ses.webRequest.onResponseStarted([filter, ]listener)` * `filter` Object * `listener` Function @@ -391,7 +391,7 @@ The `callback` has to be called with an `response` object: * `statusCode` Integer * `statusLine` String -#### `ses.webRequest.onBeforeRedirect([filter, ]listener)` +### `ses.webRequest.onBeforeRedirect([filter, ]listener)` * `filter` Object * `listener` Function @@ -410,7 +410,7 @@ The `callback` has to be called with an `response` object: * `fromCache` Boolean * `responseHeaders` Object -#### `ses.webRequest.onCompleted([filter, ]listener)` +### `ses.webRequest.onCompleted([filter, ]listener)` * `filter` Object * `listener` Function @@ -428,7 +428,7 @@ The `callback` has to be called with an `response` object: * `statusCode` Integer * `statusLine` String -#### `ses.webRequest.onErrorOccurred([filter, ]listener)` +### `ses.webRequest.onErrorOccurred([filter, ]listener)` * `filter` Object * `listener` Function diff --git a/docs-translations/ko-KR/api/menu.md b/docs-translations/ko-KR/api/menu.md index eaee7e8d4f..36e6c091c1 100644 --- a/docs-translations/ko-KR/api/menu.md +++ b/docs-translations/ko-KR/api/menu.md @@ -217,7 +217,7 @@ Menu.setApplicationMenu(menu); 새로운 메뉴를 생성합니다. -### Methods +## Methods `menu` 클래스는 다음과 같은 메서드를 가지고 있습니다: diff --git a/docs-translations/ko-KR/api/session.md b/docs-translations/ko-KR/api/session.md index a2dc9b682a..5ee37a2705 100644 --- a/docs-translations/ko-KR/api/session.md +++ b/docs-translations/ko-KR/api/session.md @@ -53,7 +53,7 @@ const ses = session.fromPartition('persist:name'); `Session` 객체는 다음과 같은 이벤트를 가지고 있습니다: -#### Event: 'will-download' +### Event: 'will-download' * `event` Event * `item` [DownloadItem](download-item.md) @@ -77,7 +77,7 @@ session.defaultSession.on('will-download', (event, item, webContents) => { `Session` 객체는 다음과 같은 메서드와 속성을 가지고 있습니다: -#### `ses.cookies` +### `ses.cookies` `cookies` 속성은 쿠키를 조작하는 방법을 제공합니다. 예를 들어 다음과 같이 할 수 있습니다: @@ -102,7 +102,7 @@ session.defaultSession.cookies.set(cookie, (error) => { }); ``` -#### `ses.cookies.get(filter, callback)` +### `ses.cookies.get(filter, callback)` * `filter` Object * `url` String (optional) - `url`에 해당하는 쿠키를 취득합니다. 이 속성을 @@ -133,7 +133,7 @@ session.defaultSession.cookies.set(cookie, (error) => { * `expirationDate` Double - (Option) UNIX 시간으로 표시되는 쿠키의 만료일에 대한 초 단위 시간. 세션 쿠키는 지원되지 않음. -#### `ses.cookies.set(details, callback)` +### `ses.cookies.set(details, callback)` * `details` Object * `url` String - 쿠키에 대한 `url` 링크. @@ -153,7 +153,7 @@ session.defaultSession.cookies.set(cookie, (error) => { `details` 객체에 따라 쿠키를 설정합니다. 작업이 완료되면 `callback`이 `callback(error)` 형태로 호출됩니다. -#### `ses.cookies.remove(url, name, callback)` +### `ses.cookies.remove(url, name, callback)` * `url` String - 쿠키와 관련된 URL입니다. * `name` String - 지울 쿠키의 이름입니다. @@ -162,20 +162,20 @@ session.defaultSession.cookies.set(cookie, (error) => { `url`과 `name`에 일치하는 쿠키를 삭제합니다. 작업이 완료되면 `callback`이 `callback()` 형식으로 호출됩니다. -#### `ses.getCacheSize(callback)` +### `ses.getCacheSize(callback)` * `callback` Function * `size` Integer - 바이트로 표현된 캐시 크기 세션의 현재 캐시 크기를 반환합니다. -#### `ses.clearCache(callback)` +### `ses.clearCache(callback)` * `callback` Function - 작업이 완료되면 호출됩니다. 세션의 HTTP 캐시를 비웁니다. -#### `ses.clearStorageData([options, ]callback)` +### `ses.clearStorageData([options, ]callback)` * `options` Object (optional), proprties: * `origin` String - `scheme://host:port`와 같은 `window.location.origin` 규칙을 @@ -189,11 +189,11 @@ session.defaultSession.cookies.set(cookie, (error) => { 웹 스토리지의 데이터를 비웁니다. -#### `ses.flushStorageData()` +### `ses.flushStorageData()` 디스크에 사용되지 않은 DOMStorage 데이터를 모두 덮어씌웁니다. -#### `ses.setProxy(config, callback)` +### `ses.setProxy(config, callback)` * `config` Object * `pacScript` String - PAC 파일과 관련된 URL입니다. @@ -240,14 +240,14 @@ proxyURL = ["://"][":"] `url`의 프록시 정보를 해석합니다. `callback`은 요청이 수행되었을 때 `callback(proxy)` 형태로 호출됩니다. -#### `ses.setDownloadPath(path)` +### `ses.setDownloadPath(path)` * `path` String - 다운로드 위치 다운로드 저장 위치를 지정합니다. 기본 다운로드 위치는 각 애플리케이션 데이터 디렉터리의 `Downloads` 폴더입니다. -#### `ses.enableNetworkEmulation(options)` +### `ses.enableNetworkEmulation(options)` * `options` Object * `offline` Boolean - 네트워크의 오프라인 상태 여부 @@ -269,11 +269,11 @@ window.webContents.session.enableNetworkEmulation({ window.webContents.session.enableNetworkEmulation({offline: true}); ``` -#### `ses.disableNetworkEmulation()` +### `ses.disableNetworkEmulation()` 활성화된 `session`의 에뮬레이션을 비활성화합니다. 기본 네트워크 설정으로 돌아갑니다. -#### `ses.setCertificateVerifyProc(proc)` +### `ses.setCertificateVerifyProc(proc)` * `proc` Function @@ -292,7 +292,7 @@ myWindow.webContents.session.setCertificateVerifyProc((hostname, cert, callback) callback(false); }); ``` -#### `ses.setPermissionRequestHandler(handler)` +### `ses.setPermissionRequestHandler(handler)` * `handler` Function * `webContents` Object - [WebContents](web-contents.md) 권한을 요청. @@ -317,13 +317,13 @@ session.fromPartition(partition).setPermissionRequestHandler((webContents, permi }); ``` -#### `ses.clearHostResolverCache([callback])` +### `ses.clearHostResolverCache([callback])` * `callback` Function (optional) - 작업이 완료되면 호출됩니다. 호스트 리소버(resolver) 캐시를 지웁니다. -#### `ses.allowNTLMCredentialsForDomains(domains)` +### `ses.allowNTLMCredentialsForDomains(domains)` * `domains` String - 통합 인증을 사용하도록 설정할 쉼표로 구분된 서버의 리스트. @@ -339,7 +339,7 @@ session.defaultSession.allowNTLMCredentialsForDomains('*example.com, *foobar.com session.defaultSession.allowNTLMCredentialsForDomains('*') ``` -#### `ses.webRequest` +### `ses.webRequest` `webRequest` API는 생명주기의 다양한 단계에 맞춰 요청 콘텐츠를 가로채거나 변경할 수 있도록 합니다. @@ -367,7 +367,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback }); ``` -#### `ses.webRequest.onBeforeRequest([filter, ]listener)` +### `ses.webRequest.onBeforeRequest([filter, ]listener)` * `filter` Object * `listener` Function @@ -396,7 +396,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback * `redirectURL` String (optional) - 원래 요청은 전송과 완료가 방지되지만 이 속성을 지정하면 해당 URL로 리다이렉트됩니다. -#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` +### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -421,7 +421,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `requestHeaders` Object (optional) - 이 속성이 제공되면, 요청은 이 헤더로 만들어 집니다. -#### `ses.webRequest.onSendHeaders([filter, ]listener)` +### `ses.webRequest.onSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -438,7 +438,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `timestamp` Double * `requestHeaders` Object -#### `ses.webRequest.onHeadersReceived([filter, ]listener)` +### `ses.webRequest.onHeadersReceived([filter, ]listener)` * `filter` Object * `listener` Function @@ -467,7 +467,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener 변경하기 위해 반드시 지정되어야 합니다. 그렇지 않은 경우, 기존의 응답 헤더의 상태가 사용됩니다. -#### `ses.webRequest.onResponseStarted([filter, ]listener)` +### `ses.webRequest.onResponseStarted([filter, ]listener)` * `filter` Object * `listener` Function @@ -486,7 +486,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `statusCode` Integer * `statusLine` String -#### `ses.webRequest.onBeforeRedirect([filter, ]listener)` +### `ses.webRequest.onBeforeRedirect([filter, ]listener)` * `filter` Object * `listener` Function @@ -506,7 +506,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `fromCache` Boolean * `responseHeaders` Object -#### `ses.webRequest.onCompleted([filter, ]listener)` +### `ses.webRequest.onCompleted([filter, ]listener)` * `filter` Object * `listener` Function @@ -524,7 +524,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `statusCode` Integer * `statusLine` String -#### `ses.webRequest.onErrorOccurred([filter, ]listener)` +### `ses.webRequest.onErrorOccurred([filter, ]listener)` * `filter` Object * `listener` Function @@ -540,7 +540,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `fromCache` Boolean * `error` String - 에러 설명. -#### `ses.protocol` +### `ses.protocol` 현재 세션의 [protocol](protocol.md) 모듈 인스턴스를 반환합니다. diff --git a/docs-translations/ko-KR/api/web-contents.md b/docs-translations/ko-KR/api/web-contents.md index 437b5dabbe..e0e5fd7771 100644 --- a/docs-translations/ko-KR/api/web-contents.md +++ b/docs-translations/ko-KR/api/web-contents.md @@ -1022,7 +1022,7 @@ win.webContents.debugger.sendCommand('Network.enable'); 지정한 커맨드를 디버깅 대상에게 전송합니다. -#### Event: 'detach' +### Event: 'detach' * `event` Event * `reason` String - 디버거 분리 사유. @@ -1030,7 +1030,7 @@ win.webContents.debugger.sendCommand('Network.enable'); 디버깅 세션이 종료될 때 발생하는 이벤트입니다. `webContents`가 닫히거나 개발자 도구가 부착된 `webContents`에 대해 호출될 때 발생합니다. -#### Event: 'message' +### Event: 'message' * `event` Event * `method` String - 메서드 이름. diff --git a/docs-translations/zh-CN/api/session.md b/docs-translations/zh-CN/api/session.md index b9664c08e6..b96290dbe3 100644 --- a/docs-translations/zh-CN/api/session.md +++ b/docs-translations/zh-CN/api/session.md @@ -47,7 +47,7 @@ var ses = session.fromPartition('persist:name'); 实例 `Session` 有以下事件: -#### Event: 'will-download' +### Event: 'will-download' * `event` Event * `item` [DownloadItem](download-item.md) @@ -70,7 +70,7 @@ session.defaultSession.on('will-download', function(event, item, webContents) { 实例 `Session` 有以下方法: -#### `ses.cookies` +### `ses.cookies` `cookies` 赋予你全力来查询和修改 cookies. 例如: @@ -94,7 +94,7 @@ session.defaultSession.cookies.set(cookie, function(error) { }); ``` -#### `ses.cookies.get(filter, callback)` +### `ses.cookies.get(filter, callback)` * `filter` Object * `url` String (可选) - 与获取 cookies 相关的 @@ -123,7 +123,7 @@ session.defaultSession.cookies.set(cookie, function(error) { cookie . * `expirationDate` Double (可选) - cookie的截至日期,数值为UNIX纪元以来的秒数. 对session cookies 不提供. -#### `ses.cookies.set(details, callback)` +### `ses.cookies.set(details, callback)` * `details` Object * `url` String - 与获取 cookies 相关的 @@ -140,7 +140,7 @@ session.defaultSession.cookies.set(cookie, function(error) { 使用 `details` 设置 cookie, 完成时使用 `callback(error)` 掉哟个 `callback` . -#### `ses.cookies.remove(url, name, callback)` +### `ses.cookies.remove(url, name, callback)` * `url` String - 与 cookies 相关的 `url`. @@ -149,20 +149,20 @@ session.defaultSession.cookies.set(cookie, function(error) { 删除匹配 `url` 和 `name` 的 cookie, 完成时使用 `callback()`调用`callback`. -#### `ses.getCacheSize(callback)` +### `ses.getCacheSize(callback)` * `callback` Function * `size` Integer - 单位 bytes 的缓存 size. 返回 session 的当前缓存 size . -#### `ses.clearCache(callback)` +### `ses.clearCache(callback)` * `callback` Function - 操作完成时调用 清空 session 的 HTTP 缓存. -#### `ses.clearStorageData([options, ]callback)` +### `ses.clearStorageData([options, ]callback)` * `options` Object (可选) * `origin` String - 应当遵循 `window.location.origin` 的格式 @@ -176,11 +176,11 @@ session.defaultSession.cookies.set(cookie, function(error) { 清除 web storages 的数据. -#### `ses.flushStorageData()` +### `ses.flushStorageData()` 将没有写入的 DOMStorage 写入磁盘. -#### `ses.setProxy(config, callback)` +### `ses.setProxy(config, callback)` * `config` Object * `pacScript` String - 与 PAC 文件相关的 URL. @@ -219,13 +219,13 @@ proxyURL = ["://"][":"] 解析 `url` 的代理信息.当请求完成的时候使用 `callback(proxy)` 调用 `callback`. -#### `ses.setDownloadPath(path)` +### `ses.setDownloadPath(path)` * `path` String - 下载地址 设置下载保存地址,默认保存地址为各自 app 应用的 `Downloads`目录. -#### `ses.enableNetworkEmulation(options)` +### `ses.enableNetworkEmulation(options)` * `options` Object * `offline` Boolean - 是否模拟网络故障. @@ -247,12 +247,12 @@ window.webContents.session.enableNetworkEmulation({ window.webContents.session.enableNetworkEmulation({offline: true}); ``` -#### `ses.disableNetworkEmulation()` +### `ses.disableNetworkEmulation()` 停止所有已经使用 `session` 的活跃模拟网络. 重置为原始网络类型. -#### `ses.setCertificateVerifyProc(proc)` +### `ses.setCertificateVerifyProc(proc)` * `proc` Function @@ -269,7 +269,7 @@ myWindow.webContents.session.setCertificateVerifyProc(function(hostname, cert, c }); ``` -#### `ses.setPermissionRequestHandler(handler)` +### `ses.setPermissionRequestHandler(handler)` * `handler` Function * `webContents` Object - [WebContents](web-contents.md) 请求许可. @@ -291,13 +291,13 @@ session.fromPartition(partition).setPermissionRequestHandler(function(webContent }); ``` -#### `ses.clearHostResolverCache([callback])` +### `ses.clearHostResolverCache([callback])` * `callback` Function (可选) - 操作结束调用. 清除主机解析缓存. -#### `ses.webRequest` +### `ses.webRequest` 在其生命周期的不同阶段,`webRequest` API 设置允许拦截并修改请求内容. @@ -319,7 +319,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, }); ``` -#### `ses.webRequest.onBeforeRequest([filter, ]listener)` +### `ses.webRequest.onBeforeRequest([filter, ]listener)` * `filter` Object * `listener` Function @@ -347,7 +347,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `cancel` Boolean (可选) * `redirectURL` String (可选) - 原始请求阻止发送或完成,而不是重定向. -#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` +### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -369,7 +369,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `cancel` Boolean (可选) * `requestHeaders` Object (可选) - 如果提供了,将使用这些 headers 来创建请求. -#### `ses.webRequest.onSendHeaders([filter, ]listener)` +### `ses.webRequest.onSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -384,7 +384,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `timestamp` Double * `requestHeaders` Object -#### `ses.webRequest.onHeadersReceived([filter,] listener)` +### `ses.webRequest.onHeadersReceived([filter,] listener)` * `filter` Object * `listener` Function @@ -408,7 +408,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `cancel` Boolean * `responseHeaders` Object (可选) - 如果提供, 服务器将假定使用这些头来响应. -#### `ses.webRequest.onResponseStarted([filter, ]listener)` +### `ses.webRequest.onResponseStarted([filter, ]listener)` * `filter` Object * `listener` Function @@ -427,7 +427,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `statusCode` Integer * `statusLine` String -#### `ses.webRequest.onBeforeRedirect([filter, ]listener)` +### `ses.webRequest.onBeforeRedirect([filter, ]listener)` * `filter` Object * `listener` Function @@ -446,7 +446,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `fromCache` Boolean * `responseHeaders` Object -#### `ses.webRequest.onCompleted([filter, ]listener)` +### `ses.webRequest.onCompleted([filter, ]listener)` * `filter` Object * `listener` Function @@ -464,7 +464,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `statusCode` Integer * `statusLine` String -#### `ses.webRequest.onErrorOccurred([filter, ]listener)` +### `ses.webRequest.onErrorOccurred([filter, ]listener)` * `filter` Object * `listener` Function diff --git a/docs-translations/zh-CN/api/web-contents.md b/docs-translations/zh-CN/api/web-contents.md index 54b9c56dcc..c05b6d2593 100644 --- a/docs-translations/zh-CN/api/web-contents.md +++ b/docs-translations/zh-CN/api/web-contents.md @@ -846,14 +846,14 @@ win.webContents.debugger.sendCommand("Network.enable"); 发送给定命令给调试目标. -#### Event: 'detach' +### Event: 'detach' * `event` Event * `reason` String - 拆分调试器原因. 在调试 session 结束时发出事件.这在 `webContents` 关闭时或 `webContents` 请求开发者工具栏时发生. -#### Event: 'message' +### Event: 'message' * `event` Event * `method` String - 方法名. diff --git a/docs/api/session.md b/docs/api/session.md index 0486b1ddbd..e4ef07d6c7 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -50,11 +50,11 @@ const session = require('electron').session; const ses = session.fromPartition('persist:name'); ``` -### Instance Events +## Events The following events are available on instances of `Session`: -#### Event: 'will-download' +### Event: 'will-download' * `event` Event * `item` [DownloadItem](download-item.md) @@ -74,11 +74,11 @@ session.defaultSession.on('will-download', (event, item, webContents) => { }); ``` -### Instance Methods +## Instance Methods The following methods are available on instances of `Session`: -#### `ses.cookies` +### `ses.cookies` The `cookies` gives you ability to query and modify cookies. For example: @@ -102,7 +102,7 @@ session.defaultSession.cookies.set(cookie, (error) => { }); ``` -#### `ses.cookies.get(filter, callback)` +### `ses.cookies.get(filter, callback)` * `filter` Object * `url` String (optional) - Retrieves cookies which are associated with @@ -134,7 +134,7 @@ with `callback(error, cookies)` on complete. the number of seconds since the UNIX epoch. Not provided for session cookies. -#### `ses.cookies.set(details, callback)` +### `ses.cookies.set(details, callback)` * `details` Object * `url` String - The url to associate the cookie with. @@ -154,7 +154,7 @@ with `callback(error, cookies)` on complete. Sets a cookie with `details`, `callback` will be called with `callback(error)` on complete. -#### `ses.cookies.remove(url, name, callback)` +### `ses.cookies.remove(url, name, callback)` * `url` String - The URL associated with the cookie. * `name` String - The name of cookie to remove. @@ -163,20 +163,20 @@ on complete. Removes the cookies matching `url` and `name`, `callback` will called with `callback()` on complete. -#### `ses.getCacheSize(callback)` +### `ses.getCacheSize(callback)` * `callback` Function * `size` Integer - Cache size used in bytes. Returns the session's current cache size. -#### `ses.clearCache(callback)` +### `ses.clearCache(callback)` * `callback` Function - Called when operation is done Clears the session’s HTTP cache. -#### `ses.clearStorageData([options, ]callback)` +### `ses.clearStorageData([options, ]callback)` * `options` Object (optional) * `origin` String - Should follow `window.location.origin`’s representation @@ -190,11 +190,11 @@ Clears the session’s HTTP cache. Clears the data of web storages. -#### `ses.flushStorageData()` +### `ses.flushStorageData()` Writes any unwritten DOMStorage data to disk. -#### `ses.setProxy(config, callback)` +### `ses.setProxy(config, callback)` * `config` Object * `pacScript` String - The URL associated with the PAC file. @@ -239,14 +239,14 @@ For example: Resolves the proxy information for `url`. The `callback` will be called with `callback(proxy)` when the request is performed. -#### `ses.setDownloadPath(path)` +### `ses.setDownloadPath(path)` * `path` String - The download location Sets download saving directory. By default, the download directory will be the `Downloads` under the respective app folder. -#### `ses.enableNetworkEmulation(options)` +### `ses.enableNetworkEmulation(options)` * `options` Object * `offline` Boolean - Whether to emulate network outage. @@ -268,12 +268,12 @@ window.webContents.session.enableNetworkEmulation({ window.webContents.session.enableNetworkEmulation({offline: true}); ``` -#### `ses.disableNetworkEmulation()` +### `ses.disableNetworkEmulation()` Disables any network emulation already active for the `session`. Resets to the original network configuration. -#### `ses.setCertificateVerifyProc(proc)` +### `ses.setCertificateVerifyProc(proc)` * `proc` Function @@ -294,7 +294,7 @@ myWindow.webContents.session.setCertificateVerifyProc((hostname, cert, callback) }); ``` -#### `ses.setPermissionRequestHandler(handler)` +### `ses.setPermissionRequestHandler(handler)` * `handler` Function * `webContents` Object - [WebContents](web-contents.md) requesting the permission. @@ -318,13 +318,13 @@ session.fromPartition(partition).setPermissionRequestHandler((webContents, permi }); ``` -#### `ses.clearHostResolverCache([callback])` +### `ses.clearHostResolverCache([callback])` * `callback` Function (optional) - Called when operation is done. Clears the host resolver cache. -#### `ses.allowNTLMCredentialsForDomains(domains)` +### `ses.allowNTLMCredentialsForDomains(domains)` * `domains` String - A comma-seperated list of servers for which integrated authentication is enabled. @@ -341,7 +341,7 @@ session.defaultSession.allowNTLMCredentialsForDomains('*example.com, *foobar.com session.defaultSession.allowNTLMCredentialsForDomains('*') ``` -#### `ses.webRequest` +### `ses.webRequest` The `webRequest` API set allows to intercept and modify contents of a request at various stages of its lifetime. @@ -370,7 +370,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback }); ``` -#### `ses.webRequest.onBeforeRequest([filter, ]listener)` +### `ses.webRequest.onBeforeRequest([filter, ]listener)` * `filter` Object * `listener` Function @@ -400,7 +400,7 @@ The `callback` has to be called with an `response` object: * `redirectURL` String (optional) - The original request is prevented from being sent or completed, and is instead redirected to the given URL. -#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` +### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -425,7 +425,7 @@ The `callback` has to be called with an `response` object: * `requestHeaders` Object (optional) - When provided, request will be made with these headers. -#### `ses.webRequest.onSendHeaders([filter, ]listener)` +### `ses.webRequest.onSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -442,7 +442,7 @@ response are visible by the time this listener is fired. * `timestamp` Double * `requestHeaders` Object -#### `ses.webRequest.onHeadersReceived([filter,]listener)` +### `ses.webRequest.onHeadersReceived([filter,]listener)` * `filter` Object * `listener` Function @@ -471,7 +471,7 @@ The `callback` has to be called with an `response` object: `responseHeaders` to change header status otherwise original response header's status will be used. -#### `ses.webRequest.onResponseStarted([filter, ]listener)` +### `ses.webRequest.onResponseStarted([filter, ]listener)` * `filter` Object * `listener` Function @@ -492,7 +492,7 @@ and response headers are available. * `statusCode` Integer * `statusLine` String -#### `ses.webRequest.onBeforeRedirect([filter, ]listener)` +### `ses.webRequest.onBeforeRedirect([filter, ]listener)` * `filter` Object * `listener` Function @@ -513,7 +513,7 @@ redirect is about to occur. * `fromCache` Boolean * `responseHeaders` Object -#### `ses.webRequest.onCompleted([filter, ]listener)` +### `ses.webRequest.onCompleted([filter, ]listener)` * `filter` Object * `listener` Function @@ -532,7 +532,7 @@ completed. * `statusCode` Integer * `statusLine` String -#### `ses.webRequest.onErrorOccurred([filter, ]listener)` +### `ses.webRequest.onErrorOccurred([filter, ]listener)` * `filter` Object * `listener` Function @@ -548,7 +548,7 @@ The `listener` will be called with `listener(details)` when an error occurs. * `fromCache` Boolean * `error` String - The error description. -#### `ses.protocol` +### `ses.protocol` Returns an instance of [protocol](protocol.md) module for this session. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index fec4708d1c..220776b058 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -1035,7 +1035,7 @@ Detaches the debugger from the `webContents`. Send given command to the debugging target. -#### Event: 'detach' +### Event: 'detach' * `event` Event * `reason` String - Reason for detaching debugger. @@ -1043,7 +1043,7 @@ Send given command to the debugging target. Emitted when debugging session is terminated. This happens either when `webContents` is closed or devtools is invoked for the attached `webContents`. -#### Event: 'message' +### Event: 'message' * `event` Event * `method` String - Method name. From 74e0535659d1f37060680e4730904c4a47e39eba Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Fri, 17 Jun 2016 12:26:08 -0700 Subject: [PATCH 02/13] use unformatted raw code examples in styleguide --- docs/styleguide.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/styleguide.md b/docs/styleguide.md index 44afe2aadb..c388b3184b 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -51,14 +51,12 @@ Here are some tips for understanding Electron documentation syntax. An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) documentation: ---- - +``` `methodName(required[, optional]))` -* `require` String (**required**) +* `required` String (**required**) * `optional` Integer - ---- +``` The method name is followed by the arguments it takes. Optional arguments are notated by brackets surrounding the optional argument as well as the comma @@ -77,15 +75,13 @@ or a custom type like Electron's [`webContent`](api/web-content.md). An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) documentation: ---- - +``` Event: 'wake-up' Returns: * `time` String - ---- +``` The event is a string that is used after a `.on` listener method. If it returns a value it and its type is noted below. If you were to listen and respond to @@ -93,6 +89,6 @@ this event it might look something like this: ```javascript Alarm.on('wake-up', (time) => { - console.log(time); -}); + console.log(time) +}) ``` From 49fd3ff41b64e388b8bd81db97b0af54f484a5dd Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Fri, 17 Jun 2016 12:33:50 -0700 Subject: [PATCH 03/13] document platform-specific arguments --- docs/styleguide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/styleguide.md b/docs/styleguide.md index c388b3184b..b4d9150ae0 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -70,6 +70,14 @@ of argument is notated by either the common types: [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or a custom type like Electron's [`webContent`](api/web-content.md). +If an argument is unique to certain platforms, those platforms are denoted +using a space-delimited italicized list following the datatype. Values can be +`OS X`, `Windows`, or `Linux`. + +``` +* `animate` Boolean (optional) _OS X_ _Windows_ +``` + ### Events An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) From a82a2485d7191acc88ba11f83bc1f5b2d05f6a5e Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Fri, 17 Jun 2016 14:01:33 -0700 Subject: [PATCH 04/13] fix debugger event headings --- docs/api/web-contents.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 220776b058..fec4708d1c 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -1035,7 +1035,7 @@ Detaches the debugger from the `webContents`. Send given command to the debugging target. -### Event: 'detach' +#### Event: 'detach' * `event` Event * `reason` String - Reason for detaching debugger. @@ -1043,7 +1043,7 @@ Send given command to the debugging target. Emitted when debugging session is terminated. This happens either when `webContents` is closed or devtools is invoked for the attached `webContents`. -### Event: 'message' +#### Event: 'message' * `event` Event * `method` String - Method name. From 574e8974b666dc202523cd49687895895ca224bd Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Mon, 20 Jun 2016 08:30:09 -0700 Subject: [PATCH 05/13] undo heading changes to special-case session --- docs/api/session.md | 58 ++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/api/session.md b/docs/api/session.md index e4ef07d6c7..0486b1ddbd 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -50,11 +50,11 @@ const session = require('electron').session; const ses = session.fromPartition('persist:name'); ``` -## Events +### Instance Events The following events are available on instances of `Session`: -### Event: 'will-download' +#### Event: 'will-download' * `event` Event * `item` [DownloadItem](download-item.md) @@ -74,11 +74,11 @@ session.defaultSession.on('will-download', (event, item, webContents) => { }); ``` -## Instance Methods +### Instance Methods The following methods are available on instances of `Session`: -### `ses.cookies` +#### `ses.cookies` The `cookies` gives you ability to query and modify cookies. For example: @@ -102,7 +102,7 @@ session.defaultSession.cookies.set(cookie, (error) => { }); ``` -### `ses.cookies.get(filter, callback)` +#### `ses.cookies.get(filter, callback)` * `filter` Object * `url` String (optional) - Retrieves cookies which are associated with @@ -134,7 +134,7 @@ with `callback(error, cookies)` on complete. the number of seconds since the UNIX epoch. Not provided for session cookies. -### `ses.cookies.set(details, callback)` +#### `ses.cookies.set(details, callback)` * `details` Object * `url` String - The url to associate the cookie with. @@ -154,7 +154,7 @@ with `callback(error, cookies)` on complete. Sets a cookie with `details`, `callback` will be called with `callback(error)` on complete. -### `ses.cookies.remove(url, name, callback)` +#### `ses.cookies.remove(url, name, callback)` * `url` String - The URL associated with the cookie. * `name` String - The name of cookie to remove. @@ -163,20 +163,20 @@ on complete. Removes the cookies matching `url` and `name`, `callback` will called with `callback()` on complete. -### `ses.getCacheSize(callback)` +#### `ses.getCacheSize(callback)` * `callback` Function * `size` Integer - Cache size used in bytes. Returns the session's current cache size. -### `ses.clearCache(callback)` +#### `ses.clearCache(callback)` * `callback` Function - Called when operation is done Clears the session’s HTTP cache. -### `ses.clearStorageData([options, ]callback)` +#### `ses.clearStorageData([options, ]callback)` * `options` Object (optional) * `origin` String - Should follow `window.location.origin`’s representation @@ -190,11 +190,11 @@ Clears the session’s HTTP cache. Clears the data of web storages. -### `ses.flushStorageData()` +#### `ses.flushStorageData()` Writes any unwritten DOMStorage data to disk. -### `ses.setProxy(config, callback)` +#### `ses.setProxy(config, callback)` * `config` Object * `pacScript` String - The URL associated with the PAC file. @@ -239,14 +239,14 @@ For example: Resolves the proxy information for `url`. The `callback` will be called with `callback(proxy)` when the request is performed. -### `ses.setDownloadPath(path)` +#### `ses.setDownloadPath(path)` * `path` String - The download location Sets download saving directory. By default, the download directory will be the `Downloads` under the respective app folder. -### `ses.enableNetworkEmulation(options)` +#### `ses.enableNetworkEmulation(options)` * `options` Object * `offline` Boolean - Whether to emulate network outage. @@ -268,12 +268,12 @@ window.webContents.session.enableNetworkEmulation({ window.webContents.session.enableNetworkEmulation({offline: true}); ``` -### `ses.disableNetworkEmulation()` +#### `ses.disableNetworkEmulation()` Disables any network emulation already active for the `session`. Resets to the original network configuration. -### `ses.setCertificateVerifyProc(proc)` +#### `ses.setCertificateVerifyProc(proc)` * `proc` Function @@ -294,7 +294,7 @@ myWindow.webContents.session.setCertificateVerifyProc((hostname, cert, callback) }); ``` -### `ses.setPermissionRequestHandler(handler)` +#### `ses.setPermissionRequestHandler(handler)` * `handler` Function * `webContents` Object - [WebContents](web-contents.md) requesting the permission. @@ -318,13 +318,13 @@ session.fromPartition(partition).setPermissionRequestHandler((webContents, permi }); ``` -### `ses.clearHostResolverCache([callback])` +#### `ses.clearHostResolverCache([callback])` * `callback` Function (optional) - Called when operation is done. Clears the host resolver cache. -### `ses.allowNTLMCredentialsForDomains(domains)` +#### `ses.allowNTLMCredentialsForDomains(domains)` * `domains` String - A comma-seperated list of servers for which integrated authentication is enabled. @@ -341,7 +341,7 @@ session.defaultSession.allowNTLMCredentialsForDomains('*example.com, *foobar.com session.defaultSession.allowNTLMCredentialsForDomains('*') ``` -### `ses.webRequest` +#### `ses.webRequest` The `webRequest` API set allows to intercept and modify contents of a request at various stages of its lifetime. @@ -370,7 +370,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback }); ``` -### `ses.webRequest.onBeforeRequest([filter, ]listener)` +#### `ses.webRequest.onBeforeRequest([filter, ]listener)` * `filter` Object * `listener` Function @@ -400,7 +400,7 @@ The `callback` has to be called with an `response` object: * `redirectURL` String (optional) - The original request is prevented from being sent or completed, and is instead redirected to the given URL. -### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` +#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -425,7 +425,7 @@ The `callback` has to be called with an `response` object: * `requestHeaders` Object (optional) - When provided, request will be made with these headers. -### `ses.webRequest.onSendHeaders([filter, ]listener)` +#### `ses.webRequest.onSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -442,7 +442,7 @@ response are visible by the time this listener is fired. * `timestamp` Double * `requestHeaders` Object -### `ses.webRequest.onHeadersReceived([filter,]listener)` +#### `ses.webRequest.onHeadersReceived([filter,]listener)` * `filter` Object * `listener` Function @@ -471,7 +471,7 @@ The `callback` has to be called with an `response` object: `responseHeaders` to change header status otherwise original response header's status will be used. -### `ses.webRequest.onResponseStarted([filter, ]listener)` +#### `ses.webRequest.onResponseStarted([filter, ]listener)` * `filter` Object * `listener` Function @@ -492,7 +492,7 @@ and response headers are available. * `statusCode` Integer * `statusLine` String -### `ses.webRequest.onBeforeRedirect([filter, ]listener)` +#### `ses.webRequest.onBeforeRedirect([filter, ]listener)` * `filter` Object * `listener` Function @@ -513,7 +513,7 @@ redirect is about to occur. * `fromCache` Boolean * `responseHeaders` Object -### `ses.webRequest.onCompleted([filter, ]listener)` +#### `ses.webRequest.onCompleted([filter, ]listener)` * `filter` Object * `listener` Function @@ -532,7 +532,7 @@ completed. * `statusCode` Integer * `statusLine` String -### `ses.webRequest.onErrorOccurred([filter, ]listener)` +#### `ses.webRequest.onErrorOccurred([filter, ]listener)` * `filter` Object * `listener` Function @@ -548,7 +548,7 @@ The `listener` will be called with `listener(details)` when an error occurs. * `fromCache` Boolean * `error` String - The error description. -### `ses.protocol` +#### `ses.protocol` Returns an instance of [protocol](protocol.md) module for this session. From 0ff50650d283fd6d9e52dde363323d60621182a2 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Mon, 20 Jun 2016 16:51:31 -0700 Subject: [PATCH 06/13] document drop-files event type --- docs/api/tray.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index aed699b8ee..a93e0dbf38 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -117,7 +117,7 @@ Emitted when any dragged items are dropped on the tray icon. #### Event: 'drop-files' _macOS_ -* `event` +* `event` Event * `files` Array - the file path of dropped files. Emitted when dragged files are dropped in the tray icon. From 46c1ef60aaa73209083d878817105957119bd5a4 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Tue, 21 Jun 2016 10:00:55 -0700 Subject: [PATCH 07/13] restore headings in translated session docs --- docs-translations/jp/api/session.md | 44 ++++++++++----------- docs-translations/ko-KR/api/session.md | 54 +++++++++++++------------- docs-translations/zh-CN/api/session.md | 50 ++++++++++++------------ 3 files changed, 74 insertions(+), 74 deletions(-) diff --git a/docs-translations/jp/api/session.md b/docs-translations/jp/api/session.md index 84e0d08deb..a5d47d404a 100644 --- a/docs-translations/jp/api/session.md +++ b/docs-translations/jp/api/session.md @@ -70,7 +70,7 @@ session.defaultSession.on('will-download', function(event, item, webContents) { `Session`のインスタンス上で次のメソッドが提供されています: -### `ses.cookies` +#### `ses.cookies` `cookies`は、cookiesに問い合わせしたり、修正をできるようにします。例: @@ -94,7 +94,7 @@ session.defaultSession.cookies.set(cookie, function(error) { }); ``` -### `ses.cookies.get(filter, callback)` +#### `ses.cookies.get(filter, callback)` * `filter` Object * `url` String (オプション) - `url`に関連付けられているcookiesを取得します。空の場合すべてのurlのcookiesを取得します @@ -122,7 +122,7 @@ session.defaultSession.cookies.set(cookie, function(error) { cookieの有効期限をUNIX時間で何秒かを示します。セッションcookiesは提供されません。 -### `ses.cookies.set(details, callback)` +#### `ses.cookies.set(details, callback)` * `details` Object * `url` String - `url`に関連付けられているcookiesを取得します。 @@ -137,7 +137,7 @@ cookieの有効期限をUNIX時間で何秒かを示します。セッションc `details`でcookieを設定し、完了すると`callback(error)`で`callback`がコールされます。 -### `ses.cookies.remove(url, name, callback)` +#### `ses.cookies.remove(url, name, callback)` * `url` String - cookieに関連付けられているURL * `name` String - 削除するcookieの名前 @@ -145,20 +145,20 @@ cookieの有効期限をUNIX時間で何秒かを示します。セッションc `url` と `name`と一致するcookiesを削除し、完了すると`callback`が、`callback()`でコールされます。 -### `ses.getCacheSize(callback)` +#### `ses.getCacheSize(callback)` * `callback` Function * `size` Integer - 使用しているキャッシュサイズバイト数 現在のセッションのキャッシュサイズを返します。 -### `ses.clearCache(callback)` +#### `ses.clearCache(callback)` * `callback` Function - 操作が完了したら、コールされます。 セッションのHTTPキャッシュをクリアします。 -### `ses.clearStorageData([options, ]callback)` +#### `ses.clearStorageData([options, ]callback)` * `options` Object (オプション) * `origin` String - `window.location.origin`の説明で、`scheme://host:port`に従う @@ -171,11 +171,11 @@ cookieの有効期限をUNIX時間で何秒かを示します。セッションc ウェブストレージのデータをクリアします。 -### `ses.flushStorageData()` +#### `ses.flushStorageData()` 書き込まれていないDOMStorageデータをディスクに書き込みます。 -### `ses.setProxy(config, callback)` +#### `ses.setProxy(config, callback)` * `config` Object * `pacScript` String - PACファイルに関連付けらえたURL @@ -213,13 +213,13 @@ proxyURL = ["://"][":"] `url`をプロキシ情報で解決します。リクエストが実行された時、`callback(proxy)`で `callback`がコールされます。 -### `ses.setDownloadPath(path)` +#### `ses.setDownloadPath(path)` * `path` String - ダウンロード場所 ダウンロードの保存ディレクトリを設定します。既定では、ダウンロードディレクトリは、個別のアプリフォルダー下の`Downloads`です。 -### `ses.enableNetworkEmulation(options)` +#### `ses.enableNetworkEmulation(options)` * `options` Object * `offline` Boolean - ネットワーク停止を再現するかどうか @@ -241,11 +241,11 @@ window.webContents.session.enableNetworkEmulation({ window.webContents.session.enableNetworkEmulation({offline: true}); ``` -### `ses.disableNetworkEmulation()` +#### `ses.disableNetworkEmulation()` `session`ですでに有効になっているネットワークエミュレーションを無効化します。オリジナルのネットワーク設定にリセットします。 -### `ses.setCertificateVerifyProc(proc)` +#### `ses.setCertificateVerifyProc(proc)` * `proc` Function @@ -262,7 +262,7 @@ myWindow.webContents.session.setCertificateVerifyProc(function(hostname, cert, c }); ``` -### `ses.webRequest` +#### `ses.webRequest` `webRequest`APIセットをインターセプトし、そのライフタイムの様々な段階でリクエストの内容を変更できます。 @@ -284,7 +284,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, }); ``` -### `ses.webRequest.onBeforeRequest([filter, ]listener)` +#### `ses.webRequest.onBeforeRequest([filter, ]listener)` * `filter` Object * `listener` Function @@ -312,7 +312,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `cancel` Boolean (オプション) * `redirectURL` String (オプション) - オリジナルリクエストが送信もしくは完了するのを中断し、代わりに付与したURLにリダイレクトします。 -### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` +#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -334,7 +334,7 @@ The `callback` has to be called with an `response` object: * `cancel` Boolean (オプション) * `requestHeaders` Object (オプション) - 付与されると、リクエストはそれらのヘッダーで作成されます。 -### `ses.webRequest.onSendHeaders([filter, ]listener)` +#### `ses.webRequest.onSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -349,7 +349,7 @@ The `callback` has to be called with an `response` object: * `timestamp` Double * `requestHeaders` Object -### `ses.webRequest.onHeadersReceived([filter,] listener)` +#### `ses.webRequest.onHeadersReceived([filter,] listener)` * `filter` Object * `listener` Function @@ -373,7 +373,7 @@ The `callback` has to be called with an `response` object: * `cancel` Boolean * `responseHeaders` Object (オプション) - 付与されていると、これらのヘッダーでサーバーはレスポンスしたと仮定します。 -### `ses.webRequest.onResponseStarted([filter, ]listener)` +#### `ses.webRequest.onResponseStarted([filter, ]listener)` * `filter` Object * `listener` Function @@ -391,7 +391,7 @@ The `callback` has to be called with an `response` object: * `statusCode` Integer * `statusLine` String -### `ses.webRequest.onBeforeRedirect([filter, ]listener)` +#### `ses.webRequest.onBeforeRedirect([filter, ]listener)` * `filter` Object * `listener` Function @@ -410,7 +410,7 @@ The `callback` has to be called with an `response` object: * `fromCache` Boolean * `responseHeaders` Object -### `ses.webRequest.onCompleted([filter, ]listener)` +#### `ses.webRequest.onCompleted([filter, ]listener)` * `filter` Object * `listener` Function @@ -428,7 +428,7 @@ The `callback` has to be called with an `response` object: * `statusCode` Integer * `statusLine` String -### `ses.webRequest.onErrorOccurred([filter, ]listener)` +#### `ses.webRequest.onErrorOccurred([filter, ]listener)` * `filter` Object * `listener` Function diff --git a/docs-translations/ko-KR/api/session.md b/docs-translations/ko-KR/api/session.md index 5ee37a2705..a2dc9b682a 100644 --- a/docs-translations/ko-KR/api/session.md +++ b/docs-translations/ko-KR/api/session.md @@ -53,7 +53,7 @@ const ses = session.fromPartition('persist:name'); `Session` 객체는 다음과 같은 이벤트를 가지고 있습니다: -### Event: 'will-download' +#### Event: 'will-download' * `event` Event * `item` [DownloadItem](download-item.md) @@ -77,7 +77,7 @@ session.defaultSession.on('will-download', (event, item, webContents) => { `Session` 객체는 다음과 같은 메서드와 속성을 가지고 있습니다: -### `ses.cookies` +#### `ses.cookies` `cookies` 속성은 쿠키를 조작하는 방법을 제공합니다. 예를 들어 다음과 같이 할 수 있습니다: @@ -102,7 +102,7 @@ session.defaultSession.cookies.set(cookie, (error) => { }); ``` -### `ses.cookies.get(filter, callback)` +#### `ses.cookies.get(filter, callback)` * `filter` Object * `url` String (optional) - `url`에 해당하는 쿠키를 취득합니다. 이 속성을 @@ -133,7 +133,7 @@ session.defaultSession.cookies.set(cookie, (error) => { * `expirationDate` Double - (Option) UNIX 시간으로 표시되는 쿠키의 만료일에 대한 초 단위 시간. 세션 쿠키는 지원되지 않음. -### `ses.cookies.set(details, callback)` +#### `ses.cookies.set(details, callback)` * `details` Object * `url` String - 쿠키에 대한 `url` 링크. @@ -153,7 +153,7 @@ session.defaultSession.cookies.set(cookie, (error) => { `details` 객체에 따라 쿠키를 설정합니다. 작업이 완료되면 `callback`이 `callback(error)` 형태로 호출됩니다. -### `ses.cookies.remove(url, name, callback)` +#### `ses.cookies.remove(url, name, callback)` * `url` String - 쿠키와 관련된 URL입니다. * `name` String - 지울 쿠키의 이름입니다. @@ -162,20 +162,20 @@ session.defaultSession.cookies.set(cookie, (error) => { `url`과 `name`에 일치하는 쿠키를 삭제합니다. 작업이 완료되면 `callback`이 `callback()` 형식으로 호출됩니다. -### `ses.getCacheSize(callback)` +#### `ses.getCacheSize(callback)` * `callback` Function * `size` Integer - 바이트로 표현된 캐시 크기 세션의 현재 캐시 크기를 반환합니다. -### `ses.clearCache(callback)` +#### `ses.clearCache(callback)` * `callback` Function - 작업이 완료되면 호출됩니다. 세션의 HTTP 캐시를 비웁니다. -### `ses.clearStorageData([options, ]callback)` +#### `ses.clearStorageData([options, ]callback)` * `options` Object (optional), proprties: * `origin` String - `scheme://host:port`와 같은 `window.location.origin` 규칙을 @@ -189,11 +189,11 @@ session.defaultSession.cookies.set(cookie, (error) => { 웹 스토리지의 데이터를 비웁니다. -### `ses.flushStorageData()` +#### `ses.flushStorageData()` 디스크에 사용되지 않은 DOMStorage 데이터를 모두 덮어씌웁니다. -### `ses.setProxy(config, callback)` +#### `ses.setProxy(config, callback)` * `config` Object * `pacScript` String - PAC 파일과 관련된 URL입니다. @@ -240,14 +240,14 @@ proxyURL = ["://"][":"] `url`의 프록시 정보를 해석합니다. `callback`은 요청이 수행되었을 때 `callback(proxy)` 형태로 호출됩니다. -### `ses.setDownloadPath(path)` +#### `ses.setDownloadPath(path)` * `path` String - 다운로드 위치 다운로드 저장 위치를 지정합니다. 기본 다운로드 위치는 각 애플리케이션 데이터 디렉터리의 `Downloads` 폴더입니다. -### `ses.enableNetworkEmulation(options)` +#### `ses.enableNetworkEmulation(options)` * `options` Object * `offline` Boolean - 네트워크의 오프라인 상태 여부 @@ -269,11 +269,11 @@ window.webContents.session.enableNetworkEmulation({ window.webContents.session.enableNetworkEmulation({offline: true}); ``` -### `ses.disableNetworkEmulation()` +#### `ses.disableNetworkEmulation()` 활성화된 `session`의 에뮬레이션을 비활성화합니다. 기본 네트워크 설정으로 돌아갑니다. -### `ses.setCertificateVerifyProc(proc)` +#### `ses.setCertificateVerifyProc(proc)` * `proc` Function @@ -292,7 +292,7 @@ myWindow.webContents.session.setCertificateVerifyProc((hostname, cert, callback) callback(false); }); ``` -### `ses.setPermissionRequestHandler(handler)` +#### `ses.setPermissionRequestHandler(handler)` * `handler` Function * `webContents` Object - [WebContents](web-contents.md) 권한을 요청. @@ -317,13 +317,13 @@ session.fromPartition(partition).setPermissionRequestHandler((webContents, permi }); ``` -### `ses.clearHostResolverCache([callback])` +#### `ses.clearHostResolverCache([callback])` * `callback` Function (optional) - 작업이 완료되면 호출됩니다. 호스트 리소버(resolver) 캐시를 지웁니다. -### `ses.allowNTLMCredentialsForDomains(domains)` +#### `ses.allowNTLMCredentialsForDomains(domains)` * `domains` String - 통합 인증을 사용하도록 설정할 쉼표로 구분된 서버의 리스트. @@ -339,7 +339,7 @@ session.defaultSession.allowNTLMCredentialsForDomains('*example.com, *foobar.com session.defaultSession.allowNTLMCredentialsForDomains('*') ``` -### `ses.webRequest` +#### `ses.webRequest` `webRequest` API는 생명주기의 다양한 단계에 맞춰 요청 콘텐츠를 가로채거나 변경할 수 있도록 합니다. @@ -367,7 +367,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback }); ``` -### `ses.webRequest.onBeforeRequest([filter, ]listener)` +#### `ses.webRequest.onBeforeRequest([filter, ]listener)` * `filter` Object * `listener` Function @@ -396,7 +396,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback * `redirectURL` String (optional) - 원래 요청은 전송과 완료가 방지되지만 이 속성을 지정하면 해당 URL로 리다이렉트됩니다. -### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` +#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -421,7 +421,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `requestHeaders` Object (optional) - 이 속성이 제공되면, 요청은 이 헤더로 만들어 집니다. -### `ses.webRequest.onSendHeaders([filter, ]listener)` +#### `ses.webRequest.onSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -438,7 +438,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `timestamp` Double * `requestHeaders` Object -### `ses.webRequest.onHeadersReceived([filter, ]listener)` +#### `ses.webRequest.onHeadersReceived([filter, ]listener)` * `filter` Object * `listener` Function @@ -467,7 +467,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener 변경하기 위해 반드시 지정되어야 합니다. 그렇지 않은 경우, 기존의 응답 헤더의 상태가 사용됩니다. -### `ses.webRequest.onResponseStarted([filter, ]listener)` +#### `ses.webRequest.onResponseStarted([filter, ]listener)` * `filter` Object * `listener` Function @@ -486,7 +486,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `statusCode` Integer * `statusLine` String -### `ses.webRequest.onBeforeRedirect([filter, ]listener)` +#### `ses.webRequest.onBeforeRedirect([filter, ]listener)` * `filter` Object * `listener` Function @@ -506,7 +506,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `fromCache` Boolean * `responseHeaders` Object -### `ses.webRequest.onCompleted([filter, ]listener)` +#### `ses.webRequest.onCompleted([filter, ]listener)` * `filter` Object * `listener` Function @@ -524,7 +524,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `statusCode` Integer * `statusLine` String -### `ses.webRequest.onErrorOccurred([filter, ]listener)` +#### `ses.webRequest.onErrorOccurred([filter, ]listener)` * `filter` Object * `listener` Function @@ -540,7 +540,7 @@ HTTP 요청을 보내기 전 요청 헤더를 사용할 수 있을 때 `listener * `fromCache` Boolean * `error` String - 에러 설명. -### `ses.protocol` +#### `ses.protocol` 현재 세션의 [protocol](protocol.md) 모듈 인스턴스를 반환합니다. diff --git a/docs-translations/zh-CN/api/session.md b/docs-translations/zh-CN/api/session.md index b96290dbe3..b9664c08e6 100644 --- a/docs-translations/zh-CN/api/session.md +++ b/docs-translations/zh-CN/api/session.md @@ -47,7 +47,7 @@ var ses = session.fromPartition('persist:name'); 实例 `Session` 有以下事件: -### Event: 'will-download' +#### Event: 'will-download' * `event` Event * `item` [DownloadItem](download-item.md) @@ -70,7 +70,7 @@ session.defaultSession.on('will-download', function(event, item, webContents) { 实例 `Session` 有以下方法: -### `ses.cookies` +#### `ses.cookies` `cookies` 赋予你全力来查询和修改 cookies. 例如: @@ -94,7 +94,7 @@ session.defaultSession.cookies.set(cookie, function(error) { }); ``` -### `ses.cookies.get(filter, callback)` +#### `ses.cookies.get(filter, callback)` * `filter` Object * `url` String (可选) - 与获取 cookies 相关的 @@ -123,7 +123,7 @@ session.defaultSession.cookies.set(cookie, function(error) { cookie . * `expirationDate` Double (可选) - cookie的截至日期,数值为UNIX纪元以来的秒数. 对session cookies 不提供. -### `ses.cookies.set(details, callback)` +#### `ses.cookies.set(details, callback)` * `details` Object * `url` String - 与获取 cookies 相关的 @@ -140,7 +140,7 @@ session.defaultSession.cookies.set(cookie, function(error) { 使用 `details` 设置 cookie, 完成时使用 `callback(error)` 掉哟个 `callback` . -### `ses.cookies.remove(url, name, callback)` +#### `ses.cookies.remove(url, name, callback)` * `url` String - 与 cookies 相关的 `url`. @@ -149,20 +149,20 @@ session.defaultSession.cookies.set(cookie, function(error) { 删除匹配 `url` 和 `name` 的 cookie, 完成时使用 `callback()`调用`callback`. -### `ses.getCacheSize(callback)` +#### `ses.getCacheSize(callback)` * `callback` Function * `size` Integer - 单位 bytes 的缓存 size. 返回 session 的当前缓存 size . -### `ses.clearCache(callback)` +#### `ses.clearCache(callback)` * `callback` Function - 操作完成时调用 清空 session 的 HTTP 缓存. -### `ses.clearStorageData([options, ]callback)` +#### `ses.clearStorageData([options, ]callback)` * `options` Object (可选) * `origin` String - 应当遵循 `window.location.origin` 的格式 @@ -176,11 +176,11 @@ session.defaultSession.cookies.set(cookie, function(error) { 清除 web storages 的数据. -### `ses.flushStorageData()` +#### `ses.flushStorageData()` 将没有写入的 DOMStorage 写入磁盘. -### `ses.setProxy(config, callback)` +#### `ses.setProxy(config, callback)` * `config` Object * `pacScript` String - 与 PAC 文件相关的 URL. @@ -219,13 +219,13 @@ proxyURL = ["://"][":"] 解析 `url` 的代理信息.当请求完成的时候使用 `callback(proxy)` 调用 `callback`. -### `ses.setDownloadPath(path)` +#### `ses.setDownloadPath(path)` * `path` String - 下载地址 设置下载保存地址,默认保存地址为各自 app 应用的 `Downloads`目录. -### `ses.enableNetworkEmulation(options)` +#### `ses.enableNetworkEmulation(options)` * `options` Object * `offline` Boolean - 是否模拟网络故障. @@ -247,12 +247,12 @@ window.webContents.session.enableNetworkEmulation({ window.webContents.session.enableNetworkEmulation({offline: true}); ``` -### `ses.disableNetworkEmulation()` +#### `ses.disableNetworkEmulation()` 停止所有已经使用 `session` 的活跃模拟网络. 重置为原始网络类型. -### `ses.setCertificateVerifyProc(proc)` +#### `ses.setCertificateVerifyProc(proc)` * `proc` Function @@ -269,7 +269,7 @@ myWindow.webContents.session.setCertificateVerifyProc(function(hostname, cert, c }); ``` -### `ses.setPermissionRequestHandler(handler)` +#### `ses.setPermissionRequestHandler(handler)` * `handler` Function * `webContents` Object - [WebContents](web-contents.md) 请求许可. @@ -291,13 +291,13 @@ session.fromPartition(partition).setPermissionRequestHandler(function(webContent }); ``` -### `ses.clearHostResolverCache([callback])` +#### `ses.clearHostResolverCache([callback])` * `callback` Function (可选) - 操作结束调用. 清除主机解析缓存. -### `ses.webRequest` +#### `ses.webRequest` 在其生命周期的不同阶段,`webRequest` API 设置允许拦截并修改请求内容. @@ -319,7 +319,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, }); ``` -### `ses.webRequest.onBeforeRequest([filter, ]listener)` +#### `ses.webRequest.onBeforeRequest([filter, ]listener)` * `filter` Object * `listener` Function @@ -347,7 +347,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `cancel` Boolean (可选) * `redirectURL` String (可选) - 原始请求阻止发送或完成,而不是重定向. -### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` +#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -369,7 +369,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `cancel` Boolean (可选) * `requestHeaders` Object (可选) - 如果提供了,将使用这些 headers 来创建请求. -### `ses.webRequest.onSendHeaders([filter, ]listener)` +#### `ses.webRequest.onSendHeaders([filter, ]listener)` * `filter` Object * `listener` Function @@ -384,7 +384,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `timestamp` Double * `requestHeaders` Object -### `ses.webRequest.onHeadersReceived([filter,] listener)` +#### `ses.webRequest.onHeadersReceived([filter,] listener)` * `filter` Object * `listener` Function @@ -408,7 +408,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `cancel` Boolean * `responseHeaders` Object (可选) - 如果提供, 服务器将假定使用这些头来响应. -### `ses.webRequest.onResponseStarted([filter, ]listener)` +#### `ses.webRequest.onResponseStarted([filter, ]listener)` * `filter` Object * `listener` Function @@ -427,7 +427,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `statusCode` Integer * `statusLine` String -### `ses.webRequest.onBeforeRedirect([filter, ]listener)` +#### `ses.webRequest.onBeforeRedirect([filter, ]listener)` * `filter` Object * `listener` Function @@ -446,7 +446,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `fromCache` Boolean * `responseHeaders` Object -### `ses.webRequest.onCompleted([filter, ]listener)` +#### `ses.webRequest.onCompleted([filter, ]listener)` * `filter` Object * `listener` Function @@ -464,7 +464,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details, * `statusCode` Integer * `statusLine` String -### `ses.webRequest.onErrorOccurred([filter, ]listener)` +#### `ses.webRequest.onErrorOccurred([filter, ]listener)` * `filter` Object * `listener` Function From 2a079b2e0a78d6c2925cb3042228ff324e8c7445 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Tue, 21 Jun 2016 11:05:34 -0700 Subject: [PATCH 08/13] =?UTF-8?q?wether=20=E2=86=92=20whether?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/web-contents.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index fec4708d1c..610fa2aa6d 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -339,9 +339,9 @@ Returns: was invoked on. Elements with source URLs are images, audio and video. * `mediaType` String - Type of the node the context menu was invoked on. Can be `none`, `image`, `audio`, `video`, `canvas`, `file` or `plugin`. - * `hasImageContent` Boolean - Wether the context menu was invoked on an image + * `hasImageContent` Boolean - Whether the context menu was invoked on an image which has non-empty contents. - * `isEditable` Boolean - Wether the context is editable. + * `isEditable` Boolean - Whether the context is editable. * `selectionText` String - Text of the selection that the context menu was invoked on. * `titleText` String - Title or alt text of the selection that the context @@ -356,29 +356,29 @@ Returns: Can be `none`, `mouse`, `keyboard`, `touch`, `touchMenu`. * `mediaFlags` Object - The flags for the media element the context menu was invoked on. See more about this below. - * `editFlags` Object - These flags indicate wether the renderer believes it is + * `editFlags` Object - These flags indicate whether the renderer believes it is able to perform the corresponding action. See more about this below. The `mediaFlags` is an object with the following properties: - * `inError` Boolean - Wether the media element has crashed. - * `isPaused` Boolean - Wether the media element is paused. - * `isMuted` Boolean - Wether the media element is muted. - * `hasAudio` Boolean - Wether the media element has audio. - * `isLooping` Boolean - Wether the media element is looping. - * `isControlsVisible` Boolean - Wether the media element's controls are + * `inError` Boolean - Whether the media element has crashed. + * `isPaused` Boolean - Whether the media element is paused. + * `isMuted` Boolean - Whether the media element is muted. + * `hasAudio` Boolean - Whether the media element has audio. + * `isLooping` Boolean - Whether the media element is looping. + * `isControlsVisible` Boolean - Whether the media element's controls are visible. - * `canToggleControls` Boolean - Wether the media element's controls are + * `canToggleControls` Boolean - Whether the media element's controls are toggleable. - * `canRotate` Boolean - Wether the media element can be rotated. + * `canRotate` Boolean - Whether the media element can be rotated. The `editFlags` is an object with the following properties: - * `canUndo` Boolean - Wether the renderer believes it can undo. - * `canRedo` Boolean - Wether the renderer believes it can redo. - * `canCut` Boolean - Wether the renderer believes it can cut. - * `canCopy` Boolean - Wether the renderer believes it can copy - * `canPaste` Boolean - Wether the renderer believes it can paste. - * `canDelete` Boolean - Wether the renderer believes it can delete. - * `canSelectAll` Boolean - Wether the renderer believes it can select all. + * `canUndo` Boolean - Whether the renderer believes it can undo. + * `canRedo` Boolean - Whether the renderer believes it can redo. + * `canCut` Boolean - Whether the renderer believes it can cut. + * `canCopy` Boolean - Whether the renderer believes it can copy + * `canPaste` Boolean - Whether the renderer believes it can paste. + * `canDelete` Boolean - Whether the renderer believes it can delete. + * `canSelectAll` Boolean - Whether the renderer believes it can select all. Emitted when there is a new context menu that needs to be handled. From 90d1b9169f22aa771425cd955d195dc3bf2ba4ae Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Tue, 21 Jun 2016 22:55:26 -0700 Subject: [PATCH 09/13] prepositions are hard --- docs/api/browser-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index e95570450b..a87be1e597 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -546,7 +546,7 @@ Focus on the window. ### `win.blur()` -Remove focus on the window. +Remove focus from the window. ### `win.isFocused()` From 72403c1a8db4167e559da928ae8e8f4343b93da6 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Tue, 21 Jun 2016 22:56:51 -0700 Subject: [PATCH 10/13] use consistent verb style --- docs/api/browser-window.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index a87be1e597..22b0124442 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -542,11 +542,11 @@ the [close event](#event-close). ### `win.focus()` -Focus on the window. +Focuses on the window. ### `win.blur()` -Remove focus from the window. +Removes focus from the window. ### `win.isFocused()` From 271c39ceb3990931a809715d9d2d66d029a3e826 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Tue, 21 Jun 2016 23:02:01 -0700 Subject: [PATCH 11/13] =?UTF-8?q?OS=20X=20=E2=86=92=20macOS?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/styleguide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/styleguide.md b/docs/styleguide.md index b4d9150ae0..21d7c63b34 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -72,10 +72,10 @@ or a custom type like Electron's [`webContent`](api/web-content.md). If an argument is unique to certain platforms, those platforms are denoted using a space-delimited italicized list following the datatype. Values can be -`OS X`, `Windows`, or `Linux`. +`macOS`, `Windows`, or `Linux`. ``` -* `animate` Boolean (optional) _OS X_ _Windows_ +* `animate` Boolean (optional) _macOS_ _Windows_ ``` ### Events From cfebf7aa6bae16d1b12f2461df7ecafea58c3202 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Thu, 23 Jun 2016 10:36:16 -0700 Subject: [PATCH 12/13] fix list indentation --- docs/api/web-contents.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 610fa2aa6d..ce0948745b 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -360,25 +360,27 @@ Returns: able to perform the corresponding action. See more about this below. The `mediaFlags` is an object with the following properties: - * `inError` Boolean - Whether the media element has crashed. - * `isPaused` Boolean - Whether the media element is paused. - * `isMuted` Boolean - Whether the media element is muted. - * `hasAudio` Boolean - Whether the media element has audio. - * `isLooping` Boolean - Whether the media element is looping. - * `isControlsVisible` Boolean - Whether the media element's controls are - visible. - * `canToggleControls` Boolean - Whether the media element's controls are - toggleable. - * `canRotate` Boolean - Whether the media element can be rotated. + +* `inError` Boolean - Whether the media element has crashed. +* `isPaused` Boolean - Whether the media element is paused. +* `isMuted` Boolean - Whether the media element is muted. +* `hasAudio` Boolean - Whether the media element has audio. +* `isLooping` Boolean - Whether the media element is looping. +* `isControlsVisible` Boolean - Whether the media element's controls are + visible. +* `canToggleControls` Boolean - Whether the media element's controls are + toggleable. +* `canRotate` Boolean - Whether the media element can be rotated. The `editFlags` is an object with the following properties: - * `canUndo` Boolean - Whether the renderer believes it can undo. - * `canRedo` Boolean - Whether the renderer believes it can redo. - * `canCut` Boolean - Whether the renderer believes it can cut. - * `canCopy` Boolean - Whether the renderer believes it can copy - * `canPaste` Boolean - Whether the renderer believes it can paste. - * `canDelete` Boolean - Whether the renderer believes it can delete. - * `canSelectAll` Boolean - Whether the renderer believes it can select all. + +* `canUndo` Boolean - Whether the renderer believes it can undo. +* `canRedo` Boolean - Whether the renderer believes it can redo. +* `canCut` Boolean - Whether the renderer believes it can cut. +* `canCopy` Boolean - Whether the renderer believes it can copy +* `canPaste` Boolean - Whether the renderer believes it can paste. +* `canDelete` Boolean - Whether the renderer believes it can delete. +* `canSelectAll` Boolean - Whether the renderer believes it can select all. Emitted when there is a new context menu that needs to be handled. From 3dcbbe9f2013746565becbbc2e1e7826a74522e6 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Thu, 23 Jun 2016 14:13:03 -0700 Subject: [PATCH 13/13] remove parens from type --- docs/api/browser-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 22b0124442..169ab0f6fa 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -945,7 +945,7 @@ convey some sort of application status or to passively notify the user. ### `win.setHasShadow(hasShadow)` _macOS_ -* `hasShadow` (Boolean) +* `hasShadow` Boolean Sets whether the window should have a shadow. On Windows and Linux does nothing.