easyproctor 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/package.json +4 -2
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# EasyProctor
|
|
2
|
+
|
|
3
|
+
Modulo web do EasyProctor.
|
|
4
|
+
|
|
5
|
+
## Instalação
|
|
6
|
+
|
|
7
|
+
Via NPM:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install --save easyproctor
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Via CDN
|
|
14
|
+
```html
|
|
15
|
+
<script>123123</script>
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Utilização
|
|
19
|
+
|
|
20
|
+
Em um bundler
|
|
21
|
+
```javascript
|
|
22
|
+
import { useProctoring } from "easyproctor";
|
|
23
|
+
|
|
24
|
+
const { start, finish, pause, resume, onLostFocus } = useProctoring("e276b448-cbee-48ae-b82c-b493aa18166e");
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Via CDN: A função "useProctoring" é injetada para ser utilizada globalmente
|
|
28
|
+
```html
|
|
29
|
+
<script src="https://cdn.jsdelivr.net/npm/easyproctor@0.0.1/unpkg/easyproctor.min.js"></script>
|
|
30
|
+
<script>
|
|
31
|
+
const { start, finish, pause, resume, onLostFocus } = useProctoring("cac34c6d-63ec-4f86-b5b0-bdeb52e8c146");
|
|
32
|
+
</script>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## API
|
|
36
|
+
```javascript
|
|
37
|
+
const {
|
|
38
|
+
// Inicia a gravação da prova
|
|
39
|
+
start,
|
|
40
|
+
|
|
41
|
+
// Finaliza a gravação da prova retornando os arquivos gerados
|
|
42
|
+
finish,
|
|
43
|
+
|
|
44
|
+
// Pausa a gravação, os dados são persistidos para a gravação poder ser continuada em outra tela
|
|
45
|
+
pause,
|
|
46
|
+
|
|
47
|
+
// Reinicia a gravação
|
|
48
|
+
resume,
|
|
49
|
+
|
|
50
|
+
// Registra uma função callback para execução de alguma lógica caso o usuária perca o foco com oa tela
|
|
51
|
+
onLostFocus
|
|
52
|
+
|
|
53
|
+
} = useProctoring("cac34c6d-63ec-4f86-b5b0-bdeb52e8c146");
|
|
54
|
+
```
|
|
55
|
+
## License
|
|
56
|
+
[MIT](https://choosealicense.com/licenses/mit/)
|
package/package.json
CHANGED
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "easyproctor",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "Modulo web de gravação do EasyProctor",
|
|
5
5
|
"main": "./index.js",
|
|
6
6
|
"module": "./esm/index.js",
|
|
7
7
|
"unpkg": "./unpkg/easyproctor.min.js",
|
|
8
8
|
"types": "./index.d.ts",
|
|
9
|
-
"keywords": [
|
|
9
|
+
"keywords": [
|
|
10
|
+
"proctoring"
|
|
11
|
+
],
|
|
10
12
|
"homepage": "https://github.com/Igor4505/render-function#readme",
|
|
11
13
|
"repository": {
|
|
12
14
|
"type": "git",
|