https://github.com/robhogan/jsc-safe-url

https://github.com/robhogan/jsc-safe-url

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/robhogan/jsc-safe-url
• Owner: robhogan
• License: other
• Created: 2023-05-11T15:05:34.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-18T16:54:36.000Z (over 1 year ago)
• Last Synced: 2024-09-19T18:48:41.167Z (about 2 months ago)
• Language: JavaScript
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## `jsc-safe-url`

JavaScriptCore santizes source URLs in error stacks by stripping query strings and fragments. Ref: [`Webkit/Webkit#49109d`](https://github.com/WebKit/WebKit/commit/49109db4ab87a715f7a8987c7ee380e63060298b).

This package contains utility functions required to implement the proposed [React Native Community RFC0646](https://github.com/react-native-community/discussions-and-proposals/pull/646). It exports three functons:

## `function isJscSafeUrl(url: string): boolean`

Returns `false` if the URL has a query component that could be stripped by JSC.

## `function toJscSafeUrl(urlToConvert: string): string`

Accepts an absolute or relative URL, and encodes any data in the input query string (if present) into the [path component](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) of the URL, by using the delimiter `//&` (which cannot appear in a normalized file path) to separate the original path from the orignal query string.

```

toJscSafeUrl('https://example.com/path?foo=bar#fragment')

// 'https://example.com/path//&foo=bar#fragment'

```

## `function toNormalUrl(urlToNormalize: string): string`

Accepts an absolute or relative URL, and replaces the first unescaped `//&` in the [path component](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) with `?`. (Effectively the reverse of `toJscSafeUrl`.)

```

toNormalUrl('https://example.com/path//&foo=bar#fragment')

// 'https://example.com/path?foo=bar#fragment'

```