Skip to content

Commit

Permalink
Update output
Browse files Browse the repository at this point in the history
  • Loading branch information
oandregal committed Mar 5, 2019
1 parent 858c4aa commit 14aab4e
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions packages/url/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const newURL = addQueryArgs( 'https://google.com', { q: 'test' } ); // https://g

**Returns**

`string` URL with arguments applied.
`string`: URL with arguments applied.

### filterURLForDisplay

Expand All @@ -57,7 +57,7 @@ const displayUrl = filterURLForDisplay( 'https://www.wordpress.org/gutenberg/' )

**Returns**

`string` Displayed URL.
`string`: Displayed URL.

### getAuthority

Expand All @@ -78,7 +78,7 @@ const authority2 = getAuthority( 'https://localhost:8080/test/' ); // 'localhost

**Returns**

`?string` The authority part of the URL.
`?string`: The authority part of the URL.

### getFragment

Expand All @@ -99,7 +99,7 @@ const fragment2 = getFragment( 'https://wordpress.org#another-fragment?query=tru

**Returns**

`?string` The fragment part of the URL.
`?string`: The fragment part of the URL.

### getPath

Expand All @@ -120,7 +120,7 @@ const path2 = getPath( 'https://wordpress.org/help/faq/' ); // 'help/faq'

**Returns**

`?string` The path part of the URL.
`?string`: The path part of the URL.

### getProtocol

Expand All @@ -141,7 +141,7 @@ const protocol2 = getProtocol( 'https://wordpress.org' ); // 'https:'

**Returns**

`?string` The protocol part of the URL.
`?string`: The protocol part of the URL.

### getQueryArg

Expand All @@ -162,7 +162,7 @@ const foo = getQueryArg( 'https://wordpress.org?foo=bar&bar=baz', 'foo' ); // ba

**Returns**

`(Array|string)` Query arg value.
`(Array|string)`: Query arg value.

### getQueryString

Expand All @@ -183,7 +183,7 @@ const queryString2 = getQueryString( 'https://wordpress.org#fragment?query=false

**Returns**

`?string` The query string part of the URL.
`?string`: The query string part of the URL.

### hasQueryArg

Expand All @@ -204,7 +204,7 @@ const hasBar = hasQueryArg( 'https://wordpress.org?foo=bar&bar=baz', 'bar' ); //

**Returns**

`boolean` Whether or not the URL contains the query arg.
`boolean`: Whether or not the URL contains the query arg.

### isURL

Expand All @@ -224,7 +224,7 @@ const isURL = isURL( 'https://wordpress.org' ); // true

**Returns**

`boolean` Whether or not it looks like a URL.
`boolean`: Whether or not it looks like a URL.

### isValidAuthority

Expand All @@ -245,7 +245,7 @@ const isNotValid = isValidAuthority( 'wordpress#org' ); // false

**Returns**

`boolean` True if the argument contains a valid authority.
`boolean`: True if the argument contains a valid authority.

### isValidFragment

Expand All @@ -266,7 +266,7 @@ const isNotValid = isValidFragment( '#invalid-#fragment' ); // false

**Returns**

`boolean` True if the argument contains a valid fragment.
`boolean`: True if the argument contains a valid fragment.

### isValidPath

Expand All @@ -287,7 +287,7 @@ const isNotValid = isValidPath( '/invalid?test/path/' ); // false

**Returns**

`boolean` True if the argument contains a valid path
`boolean`: True if the argument contains a valid path

### isValidProtocol

Expand All @@ -308,7 +308,7 @@ const isNotValid = isValidProtocol( 'https :' ); // false

**Returns**

`boolean` True if the argument is a valid protocol (e.g. http\:, tel:).
`boolean`: True if the argument is a valid protocol (e.g. http\:, tel:).

### isValidQueryString

Expand All @@ -329,7 +329,7 @@ const isNotValid = isValidQueryString( 'query=true?another=false' ); // false

**Returns**

`boolean` True if the argument contains a valid query string.
`boolean`: True if the argument contains a valid query string.

### prependHTTP

Expand All @@ -349,7 +349,7 @@ const actualURL = prependHTTP( 'wordpress.org' ); // http://wordpress.org

**Returns**

`string` The updated URL
`string`: The updated URL

### removeQueryArgs

Expand All @@ -370,7 +370,7 @@ const newUrl = removeQueryArgs( 'https://wordpress.org?foo=bar&bar=baz&baz=fooba

**Returns**

`string` Updated URL
`string`: Updated URL

### safeDecodeURI

Expand All @@ -391,7 +391,7 @@ const badUri = safeDecodeURI( '%z' ); // does not throw an Error, simply returns

**Returns**

`string` Decoded URI if possible.
`string`: Decoded URI if possible.

### safeDecodeURIComponent

Expand All @@ -406,7 +406,7 @@ Safely decodes a URI component with `decodeURIComponent`. Returns the URI compon

**Returns**

`string` Decoded URI component if possible.
`string`: Decoded URI component if possible.


<!-- END TOKEN(Autogenerated API docs) -->
Expand Down

0 comments on commit 14aab4e

Please sign in to comment.