Skip to content

Commit 58c90e3

Browse files
fenyingfenying
committed
Initial commit.
0 parents  commit 58c90e3

27 files changed

+1135
-0
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/node_modules/
2+
/lib/
3+
/samples/

‎.npmignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/.vscode/
2+
/.git/
3+
/node_modules/
4+
/tools/
5+
/.gitignore
6+
/.npmignore
7+
/tsconfig.json
8+
/tslint.json
9+
/docs/

‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock=false

‎.vscode/launch.json

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"type": "node",
9+
"request": "launch",
10+
"name": "[LiteRT/Encodings.js] Sample 01 - Errors",
11+
"program": "${workspaceFolder}/src/samples/01-errors.ts",
12+
"sourceMaps": true,
13+
"cwd": "${workspaceFolder}",
14+
"outFiles": [
15+
"${workspaceFolder}/libs/*.js",
16+
"${workspaceFolder}/samples/*.js"
17+
]
18+
}
19+
]
20+
}

‎.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"typescript.tsdk": "node_modules\\typescript\\lib"
3+
}

‎.vscode/tasks.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
// See https://go.microsoft.com/fwlink/?LinkId=733558
3+
// for the documentation about the tasks.json format
4+
"version": "2.0.0",
5+
"tasks": [
6+
{
7+
"label": "[LiteRT/Encodings.js] Build (Prefer Local Compiler)",
8+
"type": "npm",
9+
"script": "build",
10+
"problemMatcher": [
11+
"$tsc-watch"
12+
],
13+
"isBackground": true
14+
},
15+
{
16+
"label": "[LiteRT/Encodings.js] Build (Watching, Prefer Local Compiler)",
17+
"type": "npm",
18+
"script": "build-watch",
19+
"problemMatcher": [
20+
"$tsc-watch"
21+
],
22+
"isBackground": true
23+
}
24+
]
25+
}

‎CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Changes Logs

‎LICENSE

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction, and
10+
distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
13+
owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all other entities
16+
that control, are controlled by, or are under common control with that entity.
17+
For the purposes of this definition, "control" means (i) the power, direct or
18+
indirect, to cause the direction or management of such entity, whether by
19+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
22+
"You" (or "Your") shall mean an individual or Legal Entity exercising
23+
permissions granted by this License.
24+
25+
"Source" form shall mean the preferred form for making modifications, including
26+
but not limited to software source code, documentation source, and configuration
27+
files.
28+
29+
"Object" form shall mean any form resulting from mechanical transformation or
30+
translation of a Source form, including but not limited to compiled object code,
31+
generated documentation, and conversions to other media types.
32+
33+
"Work" shall mean the work of authorship, whether in Source or Object form, made
34+
available under the License, as indicated by a copyright notice that is included
35+
in or attached to the work (an example is provided in the Appendix below).
36+
37+
"Derivative Works" shall mean any work, whether in Source or Object form, that
38+
is based on (or derived from) the Work and for which the editorial revisions,
39+
annotations, elaborations, or other modifications represent, as a whole, an
40+
original work of authorship. For the purposes of this License, Derivative Works
41+
shall not include works that remain separable from, or merely link (or bind by
42+
name) to the interfaces of, the Work and Derivative Works thereof.
43+
44+
"Contribution" shall mean any work of authorship, including the original version
45+
of the Work and any modifications or additions to that Work or Derivative Works
46+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
47+
by the copyright owner or by an individual or Legal Entity authorized to submit
48+
on behalf of the copyright owner. For the purposes of this definition,
49+
"submitted" means any form of electronic, verbal, or written communication sent
50+
to the Licensor or its representatives, including but not limited to
51+
communication on electronic mailing lists, source code control systems, and
52+
issue tracking systems that are managed by, or on behalf of, the Licensor for
53+
the purpose of discussing and improving the Work, but excluding communication
54+
that is conspicuously marked or otherwise designated in writing by the copyright
55+
owner as "Not a Contribution."
56+
57+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
58+
of whom a Contribution has been received by Licensor and subsequently
59+
incorporated within the Work.
60+
61+
2. Grant of Copyright License.
62+
63+
Subject to the terms and conditions of this License, each Contributor hereby
64+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
65+
irrevocable copyright license to reproduce, prepare Derivative Works of,
66+
publicly display, publicly perform, sublicense, and distribute the Work and such
67+
Derivative Works in Source or Object form.
68+
69+
3. Grant of Patent License.
70+
71+
Subject to the terms and conditions of this License, each Contributor hereby
72+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
73+
irrevocable (except as stated in this section) patent license to make, have
74+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
75+
such license applies only to those patent claims licensable by such Contributor
76+
that are necessarily infringed by their Contribution(s) alone or by combination
77+
of their Contribution(s) with the Work to which such Contribution(s) was
78+
submitted. If You institute patent litigation against any entity (including a
79+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
80+
Contribution incorporated within the Work constitutes direct or contributory
81+
patent infringement, then any patent licenses granted to You under this License
82+
for that Work shall terminate as of the date such litigation is filed.
83+
84+
4. Redistribution.
85+
86+
You may reproduce and distribute copies of the Work or Derivative Works thereof
87+
in any medium, with or without modifications, and in Source or Object form,
88+
provided that You meet the following conditions:
89+
90+
You must give any other recipients of the Work or Derivative Works a copy of
91+
this License; and
92+
You must cause any modified files to carry prominent notices stating that You
93+
changed the files; and
94+
You must retain, in the Source form of any Derivative Works that You distribute,
95+
all copyright, patent, trademark, and attribution notices from the Source form
96+
of the Work, excluding those notices that do not pertain to any part of the
97+
Derivative Works; and
98+
If the Work includes a "NOTICE" text file as part of its distribution, then any
99+
Derivative Works that You distribute must include a readable copy of the
100+
attribution notices contained within such NOTICE file, excluding those notices
101+
that do not pertain to any part of the Derivative Works, in at least one of the
102+
following places: within a NOTICE text file distributed as part of the
103+
Derivative Works; within the Source form or documentation, if provided along
104+
with the Derivative Works; or, within a display generated by the Derivative
105+
Works, if and wherever such third-party notices normally appear. The contents of
106+
the NOTICE file are for informational purposes only and do not modify the
107+
License. You may add Your own attribution notices within Derivative Works that
108+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
109+
provided that such additional attribution notices cannot be construed as
110+
modifying the License.
111+
You may add Your own copyright statement to Your modifications and may provide
112+
additional or different license terms and conditions for use, reproduction, or
113+
distribution of Your modifications, or for any such Derivative Works as a whole,
114+
provided Your use, reproduction, and distribution of the Work otherwise complies
115+
with the conditions stated in this License.
116+
117+
5. Submission of Contributions.
118+
119+
Unless You explicitly state otherwise, any Contribution intentionally submitted
120+
for inclusion in the Work by You to the Licensor shall be under the terms and
121+
conditions of this License, without any additional terms or conditions.
122+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
123+
any separate license agreement you may have executed with Licensor regarding
124+
such Contributions.
125+
126+
6. Trademarks.
127+
128+
This License does not grant permission to use the trade names, trademarks,
129+
service marks, or product names of the Licensor, except as required for
130+
reasonable and customary use in describing the origin of the Work and
131+
reproducing the content of the NOTICE file.
132+
133+
7. Disclaimer of Warranty.
134+
135+
Unless required by applicable law or agreed to in writing, Licensor provides the
136+
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
137+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
138+
including, without limitation, any warranties or conditions of TITLE,
139+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
140+
solely responsible for determining the appropriateness of using or
141+
redistributing the Work and assume any risks associated with Your exercise of
142+
permissions under this License.
143+
144+
8. Limitation of Liability.
145+
146+
In no event and under no legal theory, whether in tort (including negligence),
147+
contract, or otherwise, unless required by applicable law (such as deliberate
148+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
149+
liable to You for damages, including any direct, indirect, special, incidental,
150+
or consequential damages of any character arising as a result of this License or
151+
out of the use or inability to use the Work (including but not limited to
152+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
153+
any and all other commercial damages or losses), even if such Contributor has
154+
been advised of the possibility of such damages.
155+
156+
9. Accepting Warranty or Additional Liability.
157+
158+
While redistributing the Work or Derivative Works thereof, You may choose to
159+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
160+
other liability obligations and/or rights consistent with this License. However,
161+
in accepting such obligations, You may act only on Your own behalf and on Your
162+
sole responsibility, not on behalf of any other Contributor, and only if You
163+
agree to indemnify, defend, and hold each Contributor harmless for any liability
164+
incurred by, or claims asserted against, such Contributor by reason of your
165+
accepting any such warranty or additional liability.
166+
167+
END OF TERMS AND CONDITIONS
168+
169+
APPENDIX: How to apply the Apache License to your work
170+
171+
To apply the Apache License to your work, attach the following boilerplate
172+
notice, with the fields enclosed by brackets "{}" replaced with your own
173+
identifying information. (Don't include the brackets!) The text should be
174+
enclosed in the appropriate comment syntax for the file format. We also
175+
recommend that a file or class name and description of purpose be included on
176+
the same "printed page" as the copyright notice for easier identification within
177+
third-party archives.

‎README.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# LiteRT/Encodings
2+
3+
[![npm version](https://img.shields.io/npm/v/@litert/encodings.svg?colorB=brightgreen)](https://www.npmjs.com/package/@litert/encodings "Stable Version")
4+
[![License](https://img.shields.io/npm/l/@litert/encodings.svg?maxAge=2592000?style=plastic)](https://github.com/litert/encodings/blob/master/LICENSE)
5+
[![GitHub issues](https://img.shields.io/github/issues/litert/encodings.js.svg)](https://github.com/litert/encodings.js/issues)
6+
[![GitHub Releases](https://img.shields.io/github/release/litert/encodings.js.svg)](https://github.com/litert/encodings.js/releases "Stable Release")
7+
8+
The buffer-based encoding utility method for node.js.
9+
Following types of encodings are supported:
10+
11+
Name | Description | Output
12+
-------------|--------------------------------------------|---------
13+
`base64` | The standard BASE64 encoding string. | string
14+
`base64url` | The URL-safe BASE64 encoding string. | string
15+
`buffer` | Node.js Buffer. | Buffer
16+
`hex` | The hexadecimal encoding string. | string
17+
`utf8` | The UTF-8 encoding string. | string
18+
`uri` | The URL-safe encoding string. | string
19+
`strict_uri` | The extended URL-safe encoding string. | string
20+
21+
> - Encoding `strict_uri` is based on `uri`, but all special chars including
22+
> `"-"`, `"."`, `"_"`, `"!"`, `"*"`, `"("`, `")"`, `"~"`, `"'"`
23+
> will be escaped.
24+
>
25+
> > NOTE: The data of `strict_uri` encoding, could be simply decoded by function
26+
> > `decodeURIComponent`.
27+
>
28+
> - Encoding `base64url` is based on `base64`, while charactor
29+
> `"="`, `"+"`, `"/"`
30+
> will be replaced with URL-safe charactors.
31+
>
32+
33+
34+
## Installation
35+
36+
```sh
37+
npm install @litert/encodings --save
38+
```
39+
40+
## Sample
41+
42+
```ts
43+
import * as Enc from "@litert/encodings";
44+
45+
Enc.convert("hello world", "buffer"); // From string to buffer.
46+
Enc.convert("hello world", "base64"); // From string to base64 string.
47+
Enc.convert("hello world", "base64url"); // From string to base64-url-escaped.
48+
Enc.convert(Buffer.from("hello world"), "uri"); // From buffer to base64-url-escaped.
49+
```
50+
51+
For more details, see documents or samples.
52+
53+
## Documents
54+
55+
- [简体中文版](./docs/zh-CN/README.md)
56+
57+
## License
58+
59+
This library is published under [Apache-2.0](./LICENSE) license.

‎docs/zh-CN/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# LiteRT/Encodings 文档
2+
3+
## 方法
4+
5+
- [base64UrlDecode](./methods/base64UrlDecode.md)
6+
- [base64UrlEncode](./methods/base64UrlEncode.md)
7+
- [compare](./methods/compare.md)
8+
- [convert](./methods/convert.md)
9+
- [encodeURIStrictly](./methods/encodeURIStrictly.md)
10+
- [getEncodings](./methods/getEncodings.md)
11+
12+
## 类型
13+
14+
- [BinaryEncodings](./types/BinaryEncodings.md)
15+
- [Encodings](./types/Encodings.md)
16+
- [StringEncodings](./types/StringEncodings.md)

‎docs/zh-CN/methods/base64UrlDecode.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# 方法 base64UrlDecode
2+
3+
该方法用于将一份字符串由 URL 安全的 BASE64 字符串编码格式转换为
4+
标准的 BASE64 字符串编码格式。
5+
6+
## 声明
7+
8+
```ts
9+
function base64UrlDecode(text: string): string;
10+
```

‎docs/zh-CN/methods/base64UrlEncode.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# 方法 base64UrlEncode
2+
3+
该方法用于将一份字符串由标准的 BASE64 字符串编码格式转换为 URL 安全的 BASE64 字符串
4+
编码格式。
5+
6+
> URL 安全的 BASE64 编码，即是将 BASE64 编码结果里的尾部 `"="` 符号去掉，将 `"+"`
7+
> 替换为 `"-"`，将 `"/"` 替换为 `"_"`。
8+
9+
## 声明
10+
11+
```ts
12+
function base64UrlEncode(text: string): string;
13+
```

‎docs/zh-CN/methods/compare.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# 方法
2+
3+
该方法用于比较不同编码的两份数据在内容上的差异。
4+
5+
[点击查看](../types/Encodings.md)支持的编码列表。
6+
7+
## 声明
8+
9+
```ts
10+
/**
11+
* 比较不同编码的两份数据是否内容上一致。
12+
*
13+
* @param {string|Buffer} a 被比较的第一份数据
14+
* @param {string|Buffer} b 被比较的第二份数据
15+
* @param {string} aEnc 第一份数据的编码
16+
* @param {string} bEnc 第二份数据的编码
17+
*/
18+
function compare(
19+
a: string | Buffer,
20+
b: string | Buffer,
21+
aEnc: Encodings,
22+
bEnc: Encodings,
23+
): number;
24+
```

0 commit comments

Comments
 (0)