summaryrefslogtreecommitdiffstats
path: root/devtools/shared/specs/property-iterator.js
blob: 991a8cede1c561b9e02bc2eb4a57935ce8234ba4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

const {
  generateActorSpec,
  Option,
  RetVal,
  types,
} = require("resource://devtools/shared/protocol.js");

types.addDictType("propertyiterator.data", {
  ownProperties: "nullable:json",
});

const propertyIteratorSpec = generateActorSpec({
  typeName: "propertyIterator",

  methods: {
    names: {
      request: {
        indexes: Option(0, "array:number"),
      },
      response: {
        names: RetVal("array:string"),
      },
    },
    slice: {
      request: {
        start: Option(0, "number"),
        count: Option(0, "number"),
      },
      response: RetVal("propertyiterator.data"),
    },
    all: {
      request: {},
      response: RetVal("propertyiterator.data"),
    },
    release: { release: true },
  },
});

exports.propertyIteratorSpec = propertyIteratorSpec;